@equinor/echo-framework 0.20.13 → 0.20.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/echo-framework",
-  "version": "0.20.13",
+  "version": "0.20.14",
   "peerDependencies": {
     "@equinor/echo-base": ">= 0.7.0 < 0.8.0",
     "@equinor/echo-components": ">= 0.11.0 < 0.12.0",
@@ -18,7 +18,8 @@
     "lodash": "4.17.21",
     "react-router-dom": "5.3.4",
     "zustand": ">= 4.4.7 < 5",
-    "react-swipeable": "7.0.1"
+    "react-swipeable": "7.0.1",
+    "immer": "10.1.1"
   },
   "main": "./index.cjs.js",
   "type": "commonjs",

package/src/lib/components/prepview/Prepview.d.ts

@@ -1,24 +1,26 @@
 import React from 'react';
-import { ColorMap, SideSheetOrientation, WorkOrderDateType } from '@equinor/echo-components';
+import { SideSheetOrientation, WorkOrderDateType } from '@equinor/echo-components';
 import { Coordinates, HistoricNotificationItem, HistoricPunchItem, HistoricWorkOrderItem, ItemTypes, WorkOrderEquipment } from './types';
 import { WorkItemType } from './utils';
+import { SEBadgeType, SNBadgeType, WoBadgeType } from './colors';
 interface PrepviewProps {
     orientation: SideSheetOrientation;
-    instCode?: string;
-    workOrderId?: string;
-    workOrderOperationId?: string;
-    notificationId?: string;
-    punchId?: string;
     headerAction?: React.ReactNode;
-    colorMap?: ColorMap;
-    workOrderDateType?: WorkOrderDateType;
     tagClicked: (tagId: string, instCode: string) => void;
-    packageClicked?: (type: ItemTypes, itemNumber: string, projectNumber: string) => void;
     historicItemClicked?: (item: HistoricNotificationItem | HistoricWorkOrderItem | HistoricPunchItem, itemType: WorkItemType) => void;
-    objectNotificationClicked?: (notification: HistoricNotificationItem) => void;
     showLongTextClicked?: (id: string, type: WorkItemType, longText: string) => void;
+    notificationId?: string;
+    currentNotificationLegendOption?: SNBadgeType;
+    workOrderId?: string;
+    currentWorkOrderLegendOption?: WoBadgeType;
+    workOrderOperationId?: string;
+    workOrderDateType?: WorkOrderDateType;
+    objectNotificationClicked?: (notification: HistoricNotificationItem) => void;
+    punchId?: string;
+    instCode?: string;
+    packageClicked?: (type: ItemTypes, itemNumber: string, projectNumber: string) => void;
+    currentEquipmentLegendOption?: SEBadgeType;
     onEquipmentLocationClick?: (coordinates: Coordinates) => void;
-    equipmentColorMap?: ColorMap;
     onEquipmentClick?: (equipment: WorkOrderEquipment) => void;
 }
 declare function Prepview(props: PrepviewProps): JSX.Element | null;

package/src/lib/components/prepview/colors/ColorMapping.d.ts

@@ -0,0 +1,37 @@
+import { ColorMap } from '@equinor/echo-components';
+import { WorkOrderDetails } from '../types';
+export declare enum SNBadgeType {
+    Status = "Status",
+    FailureImpact = "FailureImpact",
+    RequiredEndDateStatus = "RequiredEndDateStatus",
+    Count = "Count"
+}
+export declare enum WoBadgeType {
+    Status = "Status",
+    RequiredEndDateStatus = "RequiredEndDateStatus",
+    WorkOrderCount = "Count",
+    Operations = "Operations",
+    UserStatus = "UserStatus",
+    BasicFinishDateStatus = "BasicFinishDateStatus"
+}
+export declare enum SEBadgeType {
+    EquipmentGroup = "EquipmentGroup",
+    Count = "Count"
+}
+export type WorkOrderColorMapConfig = Pick<WorkOrderDetails, 'isActive' | 'requiredEndDateStatus' | 'basicFinishDateStatus' | 'activeStatusIds'>;
+/**
+ * Used to set colorMap on Notification visuals such as ListItems and CompactIconLinks
+ */
+export declare function getNotificationColorMap(currentBadgeOption: SNBadgeType | undefined, isActive?: boolean, requiredEndDateStatus?: string | undefined, failureImpact?: string | undefined): ColorMap;
+/**
+ * Converts failureImpact into failureImpactId
+ */
+export declare function convertToFailureImpactId(failureImpact: string): "X" | "S" | "D" | "U" | "";
+/**
+ * Used to set colorMap on Work order visuals such as ListItems
+ */
+export declare function getWorkOrderColorMap(currentBadgeOption: WoBadgeType | undefined, isActive: boolean, requiredEndDateStatus?: string, basicFinishDateStatus?: string): ColorMap | undefined;
+/**
+ * Used to set colorMap on Equipment visuals such as ListItems
+ */
+export declare function getEquipmentColorMap(currentBadgeOption: SEBadgeType | undefined, equipmentGroup?: string): ColorMap;

package/src/lib/components/prepview/colors/Styles.d.ts

@@ -0,0 +1,22 @@
+import { ColorMap } from '@equinor/echo-components';
+export declare const StatusStyle: {
+    [key: string]: ColorMap;
+};
+export declare const CountStyle: {
+    [key: string]: ColorMap;
+};
+export declare const ReqEndDateStyle: {
+    [key: string]: ColorMap;
+};
+export declare const UserStatusStyle: {
+    [key: string]: ColorMap;
+};
+export declare const BasicFinishStyle: {
+    [key: string]: ColorMap;
+};
+export declare const FailureImpactStyle: {
+    [key: string]: ColorMap;
+};
+export declare const EquipmentGroupStyle: {
+    [key: string]: ColorMap;
+};

package/src/lib/components/prepview/colors/index.d.ts

@@ -0,0 +1 @@
+export * from './ColorMapping';

package/src/lib/components/prepview/common/index.d.ts

@@ -1,4 +1,3 @@
-export * from '../../verticalTabsSplitView';
 export * from './details';
 export * from './error';
 export * from './fileSizeDisplay';

package/src/lib/components/prepview/context/PrepviewContext.d.ts

@@ -1,21 +1,23 @@
 import React from 'react';
-import { ColorMap, SideSheetOrientation } from '@equinor/echo-components';
+import { SideSheetOrientation } from '@equinor/echo-components';
 import { Coordinates, HistoricNotificationItem, HistoricPunchItem, HistoricWorkOrderItem, ItemTypes, WorkOrderEquipment } from '../types';
 import { WorkItemType } from '../utils';
+import { SEBadgeType, SNBadgeType, WoBadgeType } from '../colors';
 interface PrepviewContext {
-    instCode: string;
     orientation: SideSheetOrientation;
-    isWorkOrder: boolean;
-    workOrderOperationId?: string;
-    colorMap?: ColorMap;
     tagClicked: (tagId: string, instCode: string) => void;
-    packageClicked?: (type: ItemTypes, itemNumber: string, projectNumber: string) => void;
     historicItemClicked?: (item: HistoricNotificationItem | HistoricWorkOrderItem | HistoricPunchItem, itemType: WorkItemType) => void;
-    objectNotificationClicked?: (notification: HistoricNotificationItem) => void;
     showLongTextClicked?: (id: string, type: WorkItemType, longText: string) => void;
-    equipmentColorMap?: ColorMap;
+    currentNotificationLegendOption?: SNBadgeType;
+    isWorkOrder: boolean;
+    workOrderOperationId?: string;
+    objectNotificationClicked?: (notification: HistoricNotificationItem) => void;
+    currentWorkOrderLegendOption?: WoBadgeType;
+    instCode?: string;
+    packageClicked?: (type: ItemTypes, itemNumber: string, projectNumber: string) => void;
     onEquipmentClick?: (equipment: WorkOrderEquipment) => void;
     onEquipmentLocationClick?: (coordinates: Coordinates) => void;
+    currentEquipmentLegendOption?: SEBadgeType;
 }
 export declare const PrepviewContext: React.Context<PrepviewContext>;
 export declare const usePrepviewContext: () => PrepviewContext;

package/src/lib/components/prepview/notification/header/NotificationHeader.d.ts

@@ -3,5 +3,5 @@ interface NotificationHeaderProps {
     notificationDetails: NotificationDetails;
     headerAction?: React.ReactNode;
 }
-declare function NotificationHeader({ notificationDetails, headerAction }: NotificationHeaderProps): JSX.Element | null;
+declare function NotificationHeader({ notificationDetails, headerAction, }: NotificationHeaderProps): JSX.Element | null;
 export { NotificationHeader };

package/src/lib/components/prepview/types/shared.d.ts

@@ -80,6 +80,11 @@ export type HistoricNotificationItem = {
     activeStatusIds: string;
     createdDateTime: Date;
     changedDateTime: Date;
+    requiredEndDateStatusDescription?: string;
+    failureImpact?: string;
+    hasActivityLongText?: boolean;
+    hasAttachment?: boolean;
+    hasB30Document?: boolean;
 };
 export type WorkOrderGroup = {
     type: string;
@@ -88,7 +93,9 @@ export type WorkOrderGroup = {
 export type HistoricWorkOrderItem = {
     id: string;
     orderType: string;
-    isActive: true;
+    isActive: boolean;
+    requiredEndDateTime?: Date;
+    requiredEndDateStatus?: string;
     maintenancePlanDate: Date;
     planningPlant: string;
     description: string;
@@ -96,9 +103,18 @@ export type HistoricWorkOrderItem = {
     type: string;
     activeStatusIds: string;
     title: string;
+    operationId?: string;
     mainWorkCenterId: string;
     createdDateTime: Date;
     changedDateTime: Date;
+    earlyStartDate?: Date;
+    earlyFinishDate?: Date;
+    basicFinishDateStatus?: string;
+    basicFinishDateTime?: Date;
+    sortField?: string;
+    hasPrts?: boolean;
+    recordTypeIds?: string[];
+    hasB30Document?: boolean;
 };
 export type PunchGroup = {
     type: string;

package/src/lib/components/prepview/types/workorder.d.ts

@@ -20,6 +20,8 @@ export type WorkOrderDetails = FetchStatus & {
     requiredEndDateStatusDescription: string;
     basicStartDateTime: string;
     basicFinishDateTime: string;
+    basicFinishDateStatus: string;
+    basicFinishDateStatusDescription: string;
     maintenancePlanDate: string;
     maintenancePlant: string;
     planningPlantId: string;
@@ -33,6 +35,13 @@ export type WorkOrderDetails = FetchStatus & {
     description: string;
     longText: string;
     instCode: string;
+    sortField: string;
+    maintenancePlantReference: PlantReference;
+    planningPlantReference: PlantReference;
+};
+export type PlantReference = {
+    label: string;
+    typeLabel: string;
 };
 export type SubseaWorkOrderDetails = FetchStatus & {
     hasPrts: boolean;

package/src/lib/components/prepview/workorder/WorkOrder.d.ts

@@ -1,8 +1,7 @@
-import { ColorMap, WorkOrderDateType } from '@equinor/echo-components';
+import { WorkOrderDateType } from '@equinor/echo-components';
 interface WorkOrderProps {
     workOrderId: string;
     headerAction?: React.ReactNode;
-    colorMap?: ColorMap;
     workOrderDateType?: WorkOrderDateType;
 }
 declare function WorkOrder(props: WorkOrderProps): JSX.Element | null;

package/src/lib/components/prepview/workorder/header/WorkOrderHeader.d.ts

@@ -1,9 +1,8 @@
-import { ColorMap, WorkOrderDateType } from '@equinor/echo-components';
+import { WorkOrderDateType } from '@equinor/echo-components';
 import { WorkOrderDetails } from '../../types';
 interface WorkOrderHeaderProps {
     workOrderDetails: WorkOrderDetails;
     headerAction?: React.ReactNode;
-    colorMap?: ColorMap;
     workOrderDateType?: WorkOrderDateType;
 }
 declare function WorkOrderHeader(props: WorkOrderHeaderProps): JSX.Element | null;

package/src/lib/components/verticalTabsSplitView/VerticalTabsSplitView.d.ts

@@ -6,6 +6,7 @@ export type VerticalTabsGroup = {
 export type VerticalTabsItem = {
     id: string;
     title: string;
+    noItemsTitle?: string;
     content: React.ReactNode;
     amountOfItems: number;
     onClick?: () => void;

package/src/lib/services/dataLayerPanel/dataLayerPanel.store.d.ts

@@ -1,7 +1,9 @@
+import { WritableDraft } from 'immer';
 interface PanelUserSettings {
     readonly isTagsVisible: boolean;
     readonly isWorkOrdersVisible: boolean;
     readonly isEquipmentsVisible: boolean;
+    readonly isAnnotationsVisible: boolean;
 }
 interface DataLayerPanelState {
     readonly isOpen: boolean;
@@ -12,6 +14,7 @@ interface DataLayerPanelActions {
     toggleWorkOrders: () => void;
     toggleEquipments: () => void;
     toggleTags: () => void;
+    toggleAnnotations: () => void;
 }
 type DataLayerPanelStore = DataLayerPanelState & DataLayerPanelActions;
 export declare const useDataLayerPanelStore: import("zustand").UseBoundStore<Omit<Omit<Omit<Omit<import("zustand").StoreApi<DataLayerPanelStore>, "setState"> & {
@@ -37,7 +40,7 @@ export declare const useDataLayerPanelStore: import("zustand").UseBoundStore<Omi
         getOptions: () => Partial<import("zustand/middleware").PersistOptions<DataLayerPanelStore, unknown>>;
     };
 }, "setState"> & {
-    setState(nextStateOrUpdater: DataLayerPanelStore | Partial<DataLayerPanelStore> | ((state: import("immer").WritableDraft<DataLayerPanelStore>) => void), shouldReplace?: boolean | undefined, action?: string | {
+    setState(nextStateOrUpdater: DataLayerPanelStore | Partial<DataLayerPanelStore> | ((state: WritableDraft<DataLayerPanelStore>) => void), shouldReplace?: boolean | undefined, action?: string | {
         type: string;
     } | undefined): void;
 }>;