@equinor/echo-framework 0.19.1-beta-0 → 0.19.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/echo-framework",
-  "version": "0.19.1-beta-0",
+  "version": "0.19.1",
   "peerDependencies": {
     "@equinor/echo-base": ">= 0.7.0 < 0.8.0",
     "@equinor/echo-components": ">= 0.11.0 < 0.12.0",
@@ -22,4 +22,4 @@
   },
   "main": "./index.cjs.js",
   "type": "commonjs"
-}
+}

package/src/index.d.ts

@@ -4,11 +4,18 @@ import { getLegendStatusColor } from './lib/feature/legend/utils/legendUtils';
 import './lib/globalStyles.css';
 import { getPlantsInfo, getTagDetails } from './lib/services/api';
 export * from './lib/components';
+export { OpenIn3dDialogs } from './lib/components/openIn3d/OpenIn3dDialogs';
+export { OpenIn3dWarningDialog } from './lib/components/openIn3d/OpenIn3dWarningDialog';
+export { PlantNoSelectionDialog } from './lib/components/openIn3d/PlantNoSelectionDialog';
+export { SelectedItemsMenu } from './lib/components/openIn3d/SelectedItemsMenu';
 export { PrepviewButton } from './lib/components/prepviewButton/prepviewButton';
 export { RequestProCoSysAccess } from './lib/components/requestAccess/RequestProCoSysAccess';
 export { RequestSapAccess } from './lib/components/requestAccess/RequestSapAccess';
+export { WorkOrderListItem } from './lib/components/workOrderListItem';
 export * from './lib/coreApplication';
 export * from './lib/feature/equipment/index';
+export * from './lib/feature/globalSelection';
+export type { GlobalSelectionItem, OptimizedWorkOrderDto } from './lib/feature/globalSelection/globalSelectionStore/globalSelectionStore.types';
 export * from './lib/feature/legend/index';
 export { getLatestMeasurementDate, sortMeasuringPointsByMeasurementDate } from './lib/feature/measuringPoint/components/measuringPoints.utils';
 export * from './lib/feature/measuringPoint/index';
@@ -18,7 +25,6 @@ export { useIsCompactLayout } from './lib/hooks/useIsCompactLayout';
 export { useIsFullScreenModeEnabled } from './lib/hooks/useIsFullScreenModeEnabled';
 export { useScreenOrientation } from './lib/hooks/useScreenOrientation';
 export { useScreenValues } from './lib/hooks/useScreenValues';
-export * from './lib/services/activeSelectionStore';
 export { getPlantsCachedOrApi, getPlantsFromApi } from './lib/services/api/api-plants';
 export { RegisteredComponentName } from './lib/services/componentRegistry/componentRegistry';
 export * from './lib/services/eventHubActions';

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

@@ -12,9 +12,6 @@ export * from './labelledValueGrid';
 export * from './lazyLoading';
 export * from './listItemAdditionalInfoRow/listItemAdditionalInfoRow';
 export * from './mediator';
-export { OpenIn3dWarningDialog } from './openIn3d/OpenIn3dWarningDialog';
-export { PlantNoSelectionDialog } from './openIn3d/PlantNoSelectionDialog';
-export { SelectedItemsMenu } from './openIn3d/SelectedItemsMenu';
 export * from './pageMenu';
 export * from './panel';
 export * from './panelButton';
@@ -28,3 +25,4 @@ export * from './searchMenu';
 export * from './spinner/spinner';
 export * from './tagNumber';
 export * from './toaster';
+export { WorkOrderListItem } from './workOrderListItem';

package/src/lib/components/openIn3d/OpenIn3dDialogs.d.ts

@@ -0,0 +1,14 @@
+import React, { Dispatch, SetStateAction } from 'react';
+interface OpenIn3dDialogsProps {
+    isOpenIn3dWarningDialogOpen: boolean;
+    isSelectPlantNoDialogOpen: boolean;
+    setIsOpenIn3dWarningDialogOpen: Dispatch<React.SetStateAction<boolean>>;
+    setIsSelectPlantNoDialogOpen: Dispatch<React.SetStateAction<boolean>>;
+    onOKButtonClicked: () => void;
+    uniquePlantNos: string[];
+    tagNoCounts: Record<string, number>;
+    selectedPlantNo: string | undefined;
+    setSelectedPlantNo: Dispatch<SetStateAction<string | undefined>>;
+}
+export declare const OpenIn3dDialogs: React.FC<OpenIn3dDialogsProps>;
+export {};

package/src/lib/components/openIn3d/SelectedItemsMenu.d.ts

@@ -1,8 +1,10 @@
 import React from 'react';
 import { ObjectsToSendTo3dTypes } from '../../utils';
 interface SelectedItemsProps {
-    numberOfSelectedRows: number;
+    numberOfSelectedItems: number;
     onOpenIn3dButtonClick: (ObjectsToSendTo3d: ObjectsToSendTo3dTypes) => void;
+    children?: React.ReactNode;
 }
 export declare const SelectedItemsMenu: React.FC<SelectedItemsProps>;
+export declare function getIsGlobalSelectionEnabled(): boolean;
 export {};

package/src/lib/components/openIn3d/index.d.ts

@@ -1,4 +1,4 @@
+export { OpenIn3dDialogs } from './OpenIn3dDialogs';
 export { OpenIn3dWarningDialog } from './OpenIn3dWarningDialog';
 export { PlantNoSelectionDialog } from './PlantNoSelectionDialog';
 export { SelectedItemsMenu } from './SelectedItemsMenu';
-export { OpenIn3dMenu } from './openIn3dMenu';

package/src/lib/components/openIn3d/openIn3dMenu.d.ts

@@ -2,6 +2,7 @@ import React from 'react';
 import { ObjectsToSendTo3dTypes } from '../../utils/openIn3d/tagLists';
 interface OpenIn3dMenuProps {
     onOpenIn3dButtonClick: (objectsToSendTo3d: ObjectsToSendTo3dTypes) => void;
+    disabled?: boolean;
 }
 export declare const OpenIn3dMenu: React.FC<OpenIn3dMenuProps>;
 export {};

package/src/lib/components/workOrderListItem/WorkOrderListItem.d.ts

@@ -0,0 +1,14 @@
+import React from 'react';
+import { ColorMap, WorkOrderDateType, WorkOrderItem } from '@equinor/echo-components';
+export interface WorkOrderListItemProps {
+    workOrder: WorkOrderItem;
+    onCardClick?: () => void;
+    itemAction?: React.ReactNode;
+    isHeader?: boolean;
+    colorMap?: ColorMap;
+    iconName?: string;
+    workOrderDateType?: WorkOrderDateType;
+    className?: string;
+}
+declare function WorkOrderListItem(props: WorkOrderListItemProps): import("react/jsx-runtime").JSX.Element;
+export { WorkOrderListItem };

package/src/lib/components/workOrderListItem/index.d.ts

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

package/src/lib/feature/globalSelection/globalSelectionStore/globalSelectionStore.d.ts

@@ -0,0 +1,176 @@
+import { GlobalSelectionItemErrorStatuses, GlobalSelectionItemType, GlobalSelectionStore, OptimizedWorkOrderDto } from './globalSelectionStore.types';
+export declare const useGlobalSelectionStore: import("zustand").UseBoundStore<Omit<Omit<Omit<import("zustand").StoreApi<GlobalSelectionStore>, "setState"> & {
+    setState<A extends string | {
+        type: string;
+    }>(partial: GlobalSelectionStore | Partial<GlobalSelectionStore> | ((state: GlobalSelectionStore) => GlobalSelectionStore | Partial<GlobalSelectionStore>), replace?: boolean | undefined, action?: A | undefined): void;
+}, "subscribe"> & {
+    subscribe: {
+        (listener: (selectedState: GlobalSelectionStore, previousSelectedState: GlobalSelectionStore) => void): () => void;
+        <U>(selector: (state: GlobalSelectionStore) => U, listener: (selectedState: U, previousSelectedState: U) => void, options?: {
+            equalityFn?: ((a: U, b: U) => boolean) | undefined;
+            fireImmediately?: boolean | undefined;
+        } | undefined): () => void;
+    };
+}, "setState"> & {
+    setState(nextStateOrUpdater: GlobalSelectionStore | Partial<GlobalSelectionStore> | ((state: {
+        lists: ({
+            label: string;
+            key: string;
+            type: GlobalSelectionItemType.WorkOrder;
+            items: {
+                id: string;
+                type: GlobalSelectionItemType.WorkOrder;
+                data: {
+                    workOrderId: string;
+                    tagId?: string | undefined;
+                    tagPlantId: string;
+                    workCenterId?: string | undefined;
+                    workCenterPlantId: string;
+                    plannerGroupId: string;
+                    workOrderTypeId: string;
+                    revisionCodeId: string;
+                    systemId?: string | undefined;
+                    isOpen: boolean;
+                    hasStatusTECO: boolean;
+                    hasStatusRDOP: boolean;
+                    hasStatusCANC: boolean;
+                    hasStatusSTRT: boolean;
+                    hasStatusRDEX: boolean;
+                    hasStatusPREP: boolean;
+                    hasStatusPRCO: boolean;
+                    title: string;
+                    plantId: string;
+                    planningPlantId: string;
+                    sortField: string;
+                    locationId: string;
+                    revisionId: string;
+                    basicStartDateTime?: string | null | undefined;
+                    basicEndDateTime?: string | null | undefined;
+                    createdDateTime?: string | null | undefined;
+                    maintenanceRecord?: {
+                        activeStatusIds: string;
+                        completedDateTime?: string | null | undefined;
+                        correctiveWorkOrderExist?: boolean | undefined;
+                        correctiveWorkOrderId?: string | undefined;
+                        createdDateTime: string;
+                        detectionMethodGroupId?: string | undefined;
+                        detectionMethodId?: string | undefined;
+                        equipmentId: string;
+                        failureEndDateTime?: string | null | undefined;
+                        failureImpactId?: string | undefined;
+                        failureMechanismGroupId?: string | undefined;
+                        failureMechanismId?: string | undefined;
+                        failureModeGroupId?: string | undefined;
+                        failureModeId?: string | undefined;
+                        failureStartDateTime?: string | null | undefined;
+                        hasUnsafeFailureMode?: boolean | undefined;
+                        isBreakdown?: boolean | undefined;
+                        isOpen?: boolean | undefined;
+                        locationId?: string | undefined;
+                        maintenanceRecordTypeId?: string | undefined;
+                        recordId: string;
+                        requiredEndDate?: string | null | undefined;
+                        systemId?: string | undefined;
+                        tagId: string;
+                        tagPlantId: string;
+                        title: string;
+                        unsafeFailureModeStatus?: string | null | undefined;
+                        workCenterId?: string | undefined;
+                    } | null | undefined;
+                    _links: {
+                        related: string;
+                    };
+                };
+                metaData: {
+                    color: string;
+                    isHiddenByUser: boolean;
+                    errorStatuses: GlobalSelectionItemErrorStatuses[];
+                };
+            }[];
+        } | {
+            label: string;
+            key: string;
+            type: GlobalSelectionItemType.Tag;
+            items: {
+                id: string;
+                type: GlobalSelectionItemType.Tag;
+                data: {
+                    tagCategoryDescription: string;
+                    tagCategory: number;
+                    tagStatus: import("@equinor/echo-search").TagStatus;
+                    tagType: string;
+                    updatedDate: Date;
+                    locationCode: string;
+                    contrCode: string;
+                    plantNo: string;
+                    poNo: string;
+                    xCoordinate?: number | undefined;
+                    yCoordinate?: number | undefined;
+                    zCoordinate?: number | undefined;
+                    additionalFields: {
+                        type: string;
+                        value: string;
+                    }[];
+                    tagNo: string;
+                    description: string;
+                    projectCode: string;
+                    system: string;
+                };
+                metaData: {
+                    color: string;
+                    isHiddenByUser: boolean;
+                    errorStatuses: GlobalSelectionItemErrorStatuses[];
+                };
+            }[];
+        } | {
+            label: string;
+            key: string;
+            type: GlobalSelectionItemType.Equipment;
+            items: {
+                id: string;
+                type: GlobalSelectionItemType.Equipment;
+                data: {
+                    equipmentId: string;
+                    equipmentDescription: string;
+                    maintenancePlantId: string;
+                    functionalLocationId: string;
+                    manufacturer: string;
+                    materialNo: string;
+                    modelNo: string;
+                    partNo: string;
+                    serialNo: string;
+                    tagPlantId?: string | undefined;
+                    tagId?: string | undefined;
+                    locationId: string;
+                    area?: string | undefined;
+                    categoryId?: string | undefined;
+                    activeStatusIds: string[];
+                    systemStatusIds: string[];
+                    userStatusIds: string[];
+                    equipmentsStatus: string[];
+                    changedDate?: string | undefined;
+                    createdDate?: string | undefined;
+                    e3DRef?: string | undefined;
+                };
+                metaData: {
+                    color: string;
+                    isHiddenByUser: boolean;
+                    errorStatuses: GlobalSelectionItemErrorStatuses[];
+                };
+            }[];
+        })[];
+        addWorkOrderToSelection: (args: {
+            workOrder: OptimizedWorkOrderDto;
+        }) => void;
+        replaceWorkOrderSelection: (args: {
+            workOrders: OptimizedWorkOrderDto[];
+        }) => void;
+        setNotFoundItems: (args: {
+            itemIds: string[];
+        }) => void;
+        resetItemNotFoundStates: () => void;
+        resetState: () => void;
+    }) => void), shouldReplace?: boolean | undefined, action?: string | {
+        type: string;
+    } | undefined): void;
+}>;

package/src/lib/feature/globalSelection/globalSelectionStore/globalSelectionStore.types.d.ts

@@ -0,0 +1,117 @@
+import { TagSummaryDto } from '@equinor/echo-search';
+import { Equipment } from '../../equipment';
+export declare enum GlobalSelectionItemType {
+    WorkOrder = "WorkOrder",
+    Tag = "Tag",
+    Equipment = "Equipment"
+}
+interface ItemTypeToDataMap {
+    'WorkOrder': OptimizedWorkOrderDto;
+    'Tag': TagSummaryDto;
+    'Equipment': Equipment;
+}
+type GlobalSelectionList<T extends GlobalSelectionItemType> = {
+    label: string;
+    key: string;
+    type: T;
+    items: GlobalSelectionGenericItem<T>[];
+};
+export type GlobalSelectionGenericItem<T extends GlobalSelectionItemType> = {
+    id: string;
+    type: T;
+    data: ItemTypeToDataMap[T];
+    metaData: {
+        color: string;
+        isHiddenByUser: boolean;
+        errorStatuses: GlobalSelectionItemErrorStatuses[];
+    };
+};
+export type EquipmentGlobalSelectionListItem = GlobalSelectionGenericItem<GlobalSelectionItemType.Equipment>;
+export type WorkOrderGlobalSelectionListItem = GlobalSelectionGenericItem<GlobalSelectionItemType.WorkOrder>;
+export type TagGlobalSelectionListItem = GlobalSelectionGenericItem<GlobalSelectionItemType.Tag>;
+export type GlobalSelectionItem = WorkOrderGlobalSelectionListItem | TagGlobalSelectionListItem | EquipmentGlobalSelectionListItem;
+type EquipmentGlobalSelectionList = GlobalSelectionList<GlobalSelectionItemType.Equipment>;
+export type WorkOrderGlobalSelectionList = GlobalSelectionList<GlobalSelectionItemType.WorkOrder>;
+type TagGlobalSelectionList = GlobalSelectionList<GlobalSelectionItemType.Tag>;
+type GlobalSelectionListUnion = WorkOrderGlobalSelectionList | TagGlobalSelectionList | EquipmentGlobalSelectionList;
+export declare enum GlobalSelectionItemErrorStatuses {
+    NotFoundInActiveEchoModule = "NotFoundInActiveEchoModule",
+    UnableToDisplay = "UnableToDisplay"
+}
+export interface GlobalSelectionStore {
+    lists: GlobalSelectionListUnion[];
+    addWorkOrderToSelection: (args: {
+        workOrder: OptimizedWorkOrderDto;
+    }) => void;
+    replaceWorkOrderSelection: (args: {
+        workOrders: OptimizedWorkOrderDto[];
+    }) => void;
+    setNotFoundItems: (args: {
+        itemIds: string[];
+    }) => void;
+    resetItemNotFoundStates: () => void;
+    resetState: () => void;
+}
+export type OptimizedWorkOrderDto = {
+    workOrderId: string;
+    tagId?: string;
+    tagPlantId: string;
+    workCenterId?: string;
+    workCenterPlantId: string;
+    plannerGroupId: string;
+    workOrderTypeId: string;
+    revisionCodeId: string;
+    systemId?: string;
+    isOpen: boolean;
+    hasStatusTECO: boolean;
+    hasStatusRDOP: boolean;
+    hasStatusCANC: boolean;
+    hasStatusSTRT: boolean;
+    hasStatusRDEX: boolean;
+    hasStatusPREP: boolean;
+    hasStatusPRCO: boolean;
+    title: string;
+    plantId: string;
+    planningPlantId: string;
+    sortField: string;
+    locationId: string;
+    revisionId: string;
+    basicStartDateTime?: string | null;
+    basicEndDateTime?: string | null;
+    createdDateTime?: string | null;
+    maintenanceRecord?: WorkOrderMaintenanceRecord | null;
+    _links: {
+        related: string;
+    };
+};
+type WorkOrderMaintenanceRecord = {
+    activeStatusIds: string;
+    completedDateTime?: string | null;
+    correctiveWorkOrderExist?: boolean;
+    correctiveWorkOrderId?: string;
+    createdDateTime: string;
+    detectionMethodGroupId?: string;
+    detectionMethodId?: string;
+    equipmentId: string;
+    failureEndDateTime?: string | null;
+    failureImpactId?: string;
+    failureMechanismGroupId?: string;
+    failureMechanismId?: string;
+    failureModeGroupId?: string;
+    failureModeId?: string;
+    failureStartDateTime?: string | null;
+    hasUnsafeFailureMode?: boolean;
+    isBreakdown?: boolean;
+    isOpen?: boolean;
+    locationId?: string;
+    maintenanceRecordTypeId?: string;
+    recordId: string;
+    requiredEndDate?: string | null;
+    systemId?: string;
+    tagId: string;
+    tagPlantId: string;
+    title: string;
+    unsafeFailureModeStatus?: string | null;
+    workCenterId?: string;
+};
+export {};

package/src/lib/feature/globalSelection/globalSelectionStore/globalSelectionStore.utils.d.ts

@@ -0,0 +1,3 @@
+import { GlobalSelectionItem } from './globalSelectionStore.types';
+export declare function isGlobalSelectionItemNotFoundInActiveEchoModule(item: GlobalSelectionItem): boolean;
+export declare function isGlobalSelectionItemNotAbleToDisplay(item: GlobalSelectionItem): boolean;

package/src/lib/feature/globalSelection/hooks/useGlobalSelectionLists.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Hook for returning all lists stored in the global selection.
+ */
+export declare function useGlobalSelectionLists(): (import("..").WorkOrderGlobalSelectionList | {
+    label: string;
+    key: string;
+    type: import("..").GlobalSelectionItemType.Tag;
+    items: import("..").GlobalSelectionGenericItem<import("..").GlobalSelectionItemType.Tag>[];
+} | {
+    label: string;
+    key: string;
+    type: import("..").GlobalSelectionItemType.Equipment;
+    items: import("..").GlobalSelectionGenericItem<import("..").GlobalSelectionItemType.Equipment>[];
+})[];

package/src/lib/feature/globalSelection/hooks/useGlobalSelectionWorkOrders.d.ts

@@ -0,0 +1,6 @@
+import { WorkOrderGlobalSelectionListItem } from '../globalSelectionStore/globalSelectionStore.types';
+/**
+ * Returns with the stored Work Orders in the global selection
+ * @returns {Partial<WorkOrderDto>[]} Array of Work Orders
+ */
+export declare function useGlobalSelectionWorkOrders(): WorkOrderGlobalSelectionListItem[];

package/src/lib/feature/globalSelection/index.d.ts

@@ -0,0 +1,5 @@
+export { useGlobalSelectionStore } from './globalSelectionStore/globalSelectionStore';
+export * from './globalSelectionStore/globalSelectionStore.types';
+export * from './globalSelectionStore/globalSelectionStore.utils';
+export { useGlobalSelectionLists } from './hooks/useGlobalSelectionLists';
+export { useGlobalSelectionWorkOrders } from './hooks/useGlobalSelectionWorkOrders';

package/src/lib/services/activeSelectionStore/activeSelectionData.hooks.d.ts

@@ -1,10 +0,0 @@
-import { TagSummaryDto } from '@equinor/echo-search';
-import { UseQueryResult } from '@tanstack/react-query';
-/**
- * Get the tag summaries for those tags, which are part of the active selection.
- * Works with deep linking: if the selected instCode is different then the instCode in the URL
- * it will fetch the tag summaries from STID API.
- * Otherwise it will get it from echo-search.
- * @returns {UseQueryResult<TagSummaryDto[]>}
- */
-export declare function useActiveSelectedTagSummaries(): UseQueryResult<TagSummaryDto[]>;

package/src/lib/services/activeSelectionStore/activeSelectionStore.d.ts

@@ -1,27 +0,0 @@
-import * as zustand from 'zustand';
-export declare const useActiveSelectionStore: zustand.UseBoundStore<Omit<zustand.StoreApi<ActiveSelectionState>, "subscribe"> & {
-    subscribe: {
-        (listener: (selectedState: ActiveSelectionState, previousSelectedState: ActiveSelectionState) => void): () => void;
-        <U>(selector: (state: ActiveSelectionState) => U, listener: (selectedState: U, previousSelectedState: U) => void, options?: {
-            equalityFn?: ((a: U, b: U) => boolean) | undefined;
-            fireImmediately?: boolean | undefined;
-        } | undefined): () => void;
-    };
-}>;
-export type ActiveSelectionItemType = 'tagNos' | 'workOrderIds' | 'measuringPointIds';
-export type ActiveSelectionItems = {
-    [key in ActiveSelectionItemType]: string[];
-};
-export interface ActiveSelectionState {
-    items: ActiveSelectionItems;
-    userRequestAction: string | null;
-    actions: ActiveSelectionActions;
-}
-interface ActiveSelectionActions {
-    addToSelectionByType: (itemType: ActiveSelectionItemType, items: string[]) => void;
-    removeFromSelectionByType: (itemType: ActiveSelectionItemType, items: string[]) => void;
-    clearSelectionByType: (itemType: ActiveSelectionItemType) => void;
-    clearSelectionForAllTypes: () => void;
-    replaceSelection: (items: ActiveSelectionItems, action?: string) => void;
-}
-export {};

package/src/lib/services/activeSelectionStore/index.d.ts

@@ -1,2 +0,0 @@
-export * from './activeSelectionData.hooks';
-export * from './activeSelectionStore';