@equinor/echo-framework 1.1.1 → 1.3.0

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@equinor/echo-framework",
-  "version": "1.1.1",
+  "version": "1.3.0",
   "peerDependencies": {
-    "@equinor/echo-base": ">= 1.0.0 < 2.0.0",
-    "@equinor/echo-components": ">= 1.0.1 < 2.0.0",
-    "@equinor/echo-core": ">= 1.0.1 < 2.0.0",
-    "@equinor/echo-search": ">= 1.0.1 < 2.0.0",
-    "@equinor/echo-utils": ">= 1.1.1 < 2.0.0",
+    "@equinor/echo-base": ">= 1.3.0 < 2.0.0",
+    "@equinor/echo-components": ">= 1.3.0 < 2.0.0",
+    "@equinor/echo-core": ">= 1.3.0 < 2.0.0",
+    "@equinor/echo-search": ">= 1.3.0 < 2.0.0",
+    "@equinor/echo-utils": ">= 1.3.0 < 2.0.0",
     "@equinor/eds-core-react": "0.43.0",
     "@equinor/eds-icons": "0.22.0",
     "react": ">= 17.0.2",
@@ -18,14 +18,14 @@
     "lodash": "4.17.21",
     "react-router-dom": "5.3.4",
     "zustand": ">= 4.4.7 < 5",
-    "immer": "10.1.1",
-    "ag-charts-enterprise": "12.1.2"
+    "immer": "10.1.3"
   },
   "dependencies": {
-    "dexie": "4.2.0",
+    "dexie": "4.2.1",
     "mark.js": "8.11.1",
-    "ag-charts-community": "12.1.2",
-    "ag-charts-react": "12.1.2"
+    "ag-charts-community": "12.2.0",
+    "ag-charts-react": "12.2.0",
+    "ag-charts-enterprise": "12.2.0"
   },
   "main": "./index.cjs.js",
   "type": "commonjs",

package/src/index.d.ts

@@ -55,8 +55,10 @@ export * from './lib/services/leftPanelNavigation';
 export * from './lib/services/locationService/locationService';
 export { createSimpleStore } from './lib/services/stores/createSimpleStore';
 export * from './lib/services/userSetting';
+export * from './lib/types/activeTag.types';
 export * from './lib/types/api-echohub';
 export { dataAccessLinks } from './lib/types/dataAccess/dataAccessLinks';
+export { DocType } from './lib/types/docType';
 export type { EchoHubPlant } from './lib/types/echoHubPlant';
 export * from './lib/types/eventTypes';
 export * from './lib/types/extensions';
@@ -64,8 +66,10 @@ export type { BucketPanelKey, BucketSourceKey } from './lib/types/grid/bucketSid
 export type { SetActiveCommPackNo, SetActiveMcPackNo, SetActiveTagNo, TagData } from './lib/types/hookLibrary';
 export type { ModelPermissions } from './lib/types/modelPermissions';
 export { InternalApplicationLinks } from './lib/types/navigation/internalApplicationLinks';
+export { allNotificationTypes, NotificationTypes } from './lib/types/notificationTypes';
 export { PingableSources } from './lib/types/pingableSources';
 export { SearchItemDetailsType as searchItemDetailsType } from './lib/types/searchItemDetailsType';
+export { allWorkOrderTypes, WorkOrderTypes } from './lib/types/workOrderTypes';
 export * from './lib/utils';
 export { getPdmsPlantCodeForTag } from './lib/utils/getPdmsPlantCodeForTag';
 export { isImage, isVideo } from './lib/utils/mediaTypeUtils';

package/src/lib/components/contextualAppLinks/contextualAppLinks.context.d.ts

@@ -1,4 +1,4 @@
-import { TagSummaryDto } from '@equinor/echo-search';
+import type { TagSummaryDto } from '@equinor/echo-search';
 import React from 'react';
 export type ContextualAppLinksContextType = {
     tag: TagSummaryDto;

package/src/lib/components/panel/useCalculateLegendHeight.d.ts

@@ -0,0 +1 @@
+export declare const useCalculateLegendHeight: () => number;

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

@@ -26,7 +26,7 @@ export declare function getNotificationColorMap(currentBadgeOption: SNBadgeType
 /**
  * Converts failureImpact into failureImpactId
  */
-export declare function convertToFailureImpactId(failureImpact: string): "X" | "S" | "D" | "U" | "";
+export declare function convertToFailureImpactId(failureImpact: string): "" | "X" | "S" | "D" | "U";
 /**
  * Used to set colorMap on Work order visuals such as ListItems
  */

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

@@ -1,4 +1,4 @@
-import { TagSummaryDto } from '@equinor/echo-search';
+import type { TagSummaryDto } from '@equinor/echo-search';
 import React from 'react';
 interface TagsDropdownProps {
     tags: TagSummaryDto[];

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

@@ -1,5 +1,5 @@
 import { Guid } from '@equinor/echo-utils';
-import { deleteSelectionId, fetchUserSelectionIds } from './selectionMenu/selectionTreeStore/api/selectionTree.api';
+import { deleteSelectionId, fetchSelectionHistory, fetchUserSelectionIds } from './selectionMenu/selectionTreeStore/api/selectionTree.api';
 /**
  * Internal that should only be used by echopedia
  */
@@ -7,6 +7,7 @@ export declare const globalSelectionInternal: Readonly<{
     loadFromApi: typeof loadFromApi;
     deleteSelectionId: typeof deleteSelectionId;
     fetchUserSelectionIds: typeof fetchUserSelectionIds;
+    fetchSelectionHistory: typeof fetchSelectionHistory;
 }>;
 declare function loadFromApi(idToLoad: Guid): Promise<boolean>;
 export {};

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

@@ -1,4 +1,4 @@
-import { ResultArray } from '@equinor/echo-search';
+import type { ResultArray } from '@equinor/echo-search';
 import { StoreApi } from 'zustand';
 import { GlobalSelectionItemType, GlobalSelectionItemTypeToDataMap, GlobalSelectionStore, GlobalSelectionTypes, SelectionItemTypeToItemIdMap } from '../globalSelectionStore.types';
 type FetchFunction<T, U> = (itemIds: Readonly<U[]>) => Promise<{

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

@@ -1,4 +1,4 @@
-import { EquipmentData, MeasuringPointData, ResultArray, TagSummaryDto, WorkOrderData } from '@equinor/echo-search';
+import type { EquipmentData, MeasuringPointData, ResultArray, TagSummaryDto, WorkOrderData } from '@equinor/echo-search';
 import { Brand } from '@equinor/echo-utils';
 export declare enum GlobalSelectionItemType {
     WorkOrder = "WorkOrder",

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

@@ -11,6 +11,7 @@ export { useSelectionCategoriesByGroupId } from './hooks/useSelectionCategoriesB
 export { useCurrentSelectionId } from './selectionMenu/hooks/useCurrentSelectionId';
 export { useGlobalSelectionGroups } from './selectionMenu/hooks/useGlobalSelectionGroups';
 export { useMostUsedSelectionColorByIds } from './selectionMenu/hooks/useSelectionColorFrequency';
+export { useFetchSelectionHistory } from './selectionMenu/hooks/useFetchSelectionHistory';
 export { RemoveSelectionItemsConfirmDialog } from './components/RemoveSelectionItemsConfirmDialog';
 export { globalSelectionApi } from './globalSelection.api';
 export { globalSelectionInternal } from './globalSelection.internal';
@@ -19,5 +20,6 @@ export { globalSelectionUtils } from './globalSelectionStore/globalSelectionStor
 export { OpenGlobalSelectionIn3DButton } from './OpenGlobalSelectionIn3DButton';
 export { convertGlobalSelectionItemsToPlantTagPairs } from './OpenGlobalSelectionIn3DButton.utils';
 export { saveEquipmentAsNewSelectionToApi } from './selectionMenu/selectionTreeStore/api/selectionTree.equipment';
+export { invalidateHistorySelectionQuery } from './selectionMenu/invalidateHistorySelectionQuery';
 export { SelectionColorConflictDialog } from './selectionMenu/selectionTreeStore/colorConflictHandling/SelectionColorConflictDialog';
 export { simulatedSelectionTreeApiError } from './selectionMenu/selectionTreeStore/persist/devOnlySimulateOffline';

package/src/lib/feature/globalSelection/selectionMenu/hooks/useFetchSelectionHistory.d.ts

@@ -0,0 +1,5 @@
+export declare const historySelectionQueryKey = "historySelection";
+export declare const useFetchSelectionHistory: () => {
+    status: "error" | "success" | "pending";
+    data: import("../selectionTreeStore/selectionTree.api.types").ApiSelectionHistory[] | undefined;
+};

package/src/lib/feature/globalSelection/selectionMenu/invalidateHistorySelectionQuery.d.ts

@@ -0,0 +1 @@
+export declare const invalidateHistorySelectionQuery: () => Promise<void>;

package/src/lib/feature/globalSelection/selectionMenu/selectionTreeStore/api/selectionTree.api.d.ts

@@ -1,5 +1,5 @@
 import { Guid } from '@equinor/echo-utils';
-import { ApiSelectionTreeRoot, ApiSelectionTreeRootBase } from '../selectionTree.api.types';
+import { ApiSelectionHistory, ApiSelectionTreeRoot, ApiSelectionTreeRootBase } from '../selectionTree.api.types';
 import { SelectionGroup } from '../selectionTree.store.types';
 /**
  * Maps the selection tree data to the API format.
@@ -15,5 +15,6 @@ export declare function saveSelectionTreeToApi(args: {
     itemToSave: ApiSelectionTreeRootBase;
 }): Promise<Guid | undefined>;
 export declare function fetchSelectionTreeById(id: string): Promise<ApiSelectionTreeRoot | undefined>;
+export declare function fetchSelectionHistory(): Promise<ApiSelectionHistory[] | undefined>;
 export declare function fetchUserSelectionIds(): Promise<Guid[]>;
-export declare function deleteSelectionId(id: string): Promise<void>;
+export declare function deleteSelectionId(id: Guid): Promise<void>;

package/src/lib/feature/globalSelection/selectionMenu/selectionTreeStore/persist/selectionTree.load.utils.d.ts

@@ -1,5 +1,6 @@
-import { ApiSelectionGroup, ApiSelectionTreeRootBase } from '../selectionTree.api.types';
 import { GlobalSelectionItemType, GlobalSelectionObject, GlobalSelectionTypes } from '../../../globalSelectionStore/globalSelectionStore.types';
+import { ApiSelectionGroup, ApiSelectionTreeRootBase } from '../selectionTree.api.types';
+import { SelectionGroup } from '../selectionTree.store.types';
 /**
  * Processes API selection tree data and organizes item IDs by their types.
  *
@@ -40,3 +41,14 @@ export declare function createListsByTypeFromApiData({ data }: {
  * @returns A new array of selection groups with colors assigned to items as needed.
  */
 export declare function applyColorsOnSelectionApiData(groups: ApiSelectionGroup[]): ApiSelectionGroup[];
+/**
+ * Builds an array of `SelectionGroup` objects from the provided API selection tree root.
+ *
+ * This function maps the API data structure into the application's selection tree format,
+ * transforming each group and its categories accordingly. It also ensures that the local
+ * selection group is inserted at the correct position within the resulting array.
+ *
+ * @param root - The root object from the API containing selection tree data.
+ * @returns An array of `SelectionGroup` objects constructed from the API data, with the local selection group positioned as specified.
+ */
+export declare function buildSelectionTreeFromApi(root: ApiSelectionTreeRootBase): SelectionGroup[];

package/src/lib/feature/globalSelection/selectionMenu/selectionTreeStore/selectionTree.api.types.d.ts

@@ -31,4 +31,10 @@ export interface ApiSelectionTreeItem {
     readonly id: ApiSelectionTreeItemId;
     readonly metaData?: ApiGlobalSelectionMetaData;
 }
+export interface ApiSelectionHistory {
+    readonly id: Guid;
+    readonly lastChangedUtc: Date;
+    readonly totalItems: number;
+}
 export declare function cleanApiSelectionTreeRoot(root: ApiSelectionTreeRoot): ApiSelectionTreeRoot;
+export declare function cleanApiSelectionHistory(roots: ApiSelectionHistory[]): ApiSelectionHistory[];

package/src/lib/feature/globalSelection/selectionMenu/selectionTreeStore/selectionTree.store.types.d.ts

@@ -29,6 +29,7 @@ export interface SelectionTreeData {
     currentSelectionId?: Guid;
     readonly groups: SelectionGroup[];
 }
+export declare const itemTypeToCategoryId: Record<GlobalSelectionItemType, GlobalSelectionCategoryId>;
 export interface SelectionTreeStore extends SelectionTreeData {
     setCurrentSelectionId: (args: {
         guid: Guid | undefined;

package/src/lib/feature/legend/legendVisibleDataAsTagsStore.type.d.ts

@@ -1,4 +1,4 @@
-import { TagSummaryDto } from '@equinor/echo-search';
+import type { TagSummaryDto } from '@equinor/echo-search';
 export interface TagWithEquipmentId {
     readonly tagNo: string;
     readonly instCode: string;

package/src/lib/feature/measuringPoint/types/measuringPoint.d.ts

@@ -1,4 +1,4 @@
-import { MeasuringPointData } from '@equinor/echo-search';
+import type { MeasuringPointData } from '@equinor/echo-search';
 export interface MeasurementDto {
     measurementId: string;
     measuringPointId: string;

package/src/lib/types/activeTag.types.d.ts

@@ -0,0 +1,79 @@
+import { DocType } from './docType';
+import { NotificationTypes } from './notificationTypes';
+import { WorkOrderTypes } from './workOrderTypes';
+/**
+ * Enum representing the different types of accordions available for tag information display,
+ * in the Search Panel, for a given active tag.
+ *
+ * @remarks
+ * This enum is used to specify the type of information section (accordion) shown for a tag,
+ * such as general tag information, 3D model view, bolt tension details, measuring points, or work permits.
+ *
+ * @enum
+ * @property {string} TagInformation - Accordion for general tag information.
+ * @property {string} E3D - Accordion for 3D model visualization.
+ * @property {string} BoltTension - Accordion for bolt tension details.
+ * @property {string} MeasuringPoints - Accordion for measuring point information.
+ * @property {string} WorkPermit - Accordion for work permit details.
+ */
+export declare enum TagInfoAccordionTypes {
+    TagInformation = "Tag information",
+    E3D = "E3D",
+    BoltTension = "Bolt tension",
+    MeasuringPoints = "Measuring Point",
+    WorkPermit = "WorkPermit"
+}
+export declare enum ProCoSysChecklistGroup {
+    CPCL = "CPCL",
+    MCCR = "MCCR",
+    P = "Preservation",
+    RL = "RunningLogs",
+    DCCL = "DeCommissioningCheckList",
+    FAIL = "Unknown Form Group"
+}
+export { NotificationTypes, WorkOrderTypes };
+export type TagItemSubTabType = TagInfoAccordionTypes | WorkOrderTypes | NotificationTypes | ProCoSysChecklistGroup | DocType | string;
+export declare enum NonDocTabs {
+    Info = "Info",
+    Documents = "Docs",
+    RealTime = "Real time",
+    Media = "Media",
+    WorkOrders = "Work Orders",
+    Notifications = "Notifs.",
+    WorkPermits = "Work Permits",
+    Punch = "Punch",
+    Checklist = "Checklist",
+    MeasuringPoints = "Measuring Points",
+    EquipmentInfo = "Equip.",
+    IocAnnotations = "IOC Annotations"
+}
+export type TagItemContentTabsType = NonDocTabs | DocType;
+/**
+ * Arguments for setting the active tag in the application.
+ *
+ * Used by the returned function of useSetActiveTagNo() hook.
+ *
+ * @property tagNo - The unique identifier of the tag to activate.
+ * @property activeTagTab - (Optional) The currently active tab for the tag item.
+ * @property activeTagSubTab - (Optional) The currently active sub-tab for the tag item.
+ * @property instCode - (Optional) The instrument code associated with the tag.
+ * @property activePanelKey - (Optional) The key of the panel to activate.
+ * @property keepLastNavigationItem - (Optional) Whether to keep the last navigation item in the navigation stack.
+ * @property openInPanel - (Optional) Whether to open the tag in a panel.
+ * @property displayMessageOnItemNotFound - (Optional) Whether to display a message if the tag item is not found.
+ * @property allowToggle - (Optional) Whether toggling the active state is allowed.
+ * @property omitTagNoFromUrl - (Optional, deprecated) Used only by echo maps. Planned for removal when echo-maps is no longer part of echo.
+ */
+export type SetActiveTagNoArgs = {
+    tagNo: string;
+    activeTagTab?: TagItemContentTabsType;
+    activeTagSubTab?: TagItemSubTabType;
+    instCode?: string;
+    activePanelKey?: string;
+    keepLastNavigationItem?: boolean;
+    openInPanel?: boolean;
+    displayMessageOnItemNotFound?: boolean;
+    allowToggle?: boolean;
+    /** @deprecated Used only by echo maps. Planned for removal when echo-maps is no longer part of echo. */
+    omitTagNoFromUrl?: boolean;
+};

package/src/lib/types/dataAccess/dataAccessLinks.d.ts

@@ -44,3 +44,4 @@ export declare const dataAccessLinks: {
         url: string;
     };
 };
+export declare function createPlantNameQueryParam(plantName: string): string;

package/src/lib/types/docType.d.ts

@@ -0,0 +1,16 @@
+export declare enum DocType {
+    pid = "pid",
+    processFlowDiagram = "processFlowDiagram",
+    iso = "iso",
+    did = "did",
+    scd = "scd",
+    causeEffect = "causeEffect",
+    fpds = "fpds",
+    layout = "layout",
+    loop = "loop",
+    blockDiagram = "blockDiagram",
+    wire = "wire",
+    detail = "detail",
+    opl = "opl",
+    other = "other"
+}

package/src/lib/types/notificationTypes.d.ts

@@ -0,0 +1,10 @@
+export declare enum NotificationTypes {
+    M1 = "M1",
+    M2 = "M2",
+    M3 = "M3",
+    M4 = "M4",
+    M5 = "M5",
+    M6 = "M6",
+    M9 = "M9"
+}
+export declare const allNotificationTypes: ReadonlyArray<NotificationTypes>;

package/src/lib/types/workOrderTypes.d.ts

@@ -0,0 +1,12 @@
+export declare enum WorkOrderTypes {
+    PM01 = "PM01",
+    PM02 = "PM02",
+    PM03 = "PM03",
+    PM04 = "PM04",
+    PM05 = "PM05",
+    PM06 = "PM06",
+    PM10 = "PM10",
+    PM15 = "PM15",
+    PM20 = "PM20"
+}
+export declare const allWorkOrderTypes: ReadonlyArray<WorkOrderTypes>;

package/src/lib/__mocks__/mockedProjects.d.ts

@@ -1,16 +0,0 @@
-export declare const mockedProjects: {
-    projectCode: string;
-    stidDeliveryCode: number;
-    description: string;
-    isRevProject: string;
-    filter: {
-        value: string;
-        text: string;
-    };
-    instCode: string;
-    insertedDate: string;
-    insertedBy: string;
-    updatedDate: string;
-    updatedBy: string;
-    validFlg: string;
-}[];

package/src/lib/__mocks__/mockedTags.d.ts

@@ -1,5 +0,0 @@
-import { TagSummaryDto } from '@equinor/echo-search';
-export declare const mockedArchivedTags: TagSummaryDto[];
-export declare const mockedNonArchivedTags: TagSummaryDto[];
-export declare const mockedTags: TagSummaryDto[];
-export declare const estimatedTagCount: number;

package/src/lib/__mocks__/mockedWorkOrders.d.ts

@@ -1,4 +0,0 @@
-import { WorkOrderDetailsDto } from '@equinor/echo-search';
-export declare const mockedOpenWorkOrders: WorkOrderDetailsDto[];
-export declare const mockedClosedWorkOrders: WorkOrderDetailsDto[];
-export declare const mockedWorkOrders: WorkOrderDetailsDto[];

package/src/lib/__mocks__/plants.d.ts

@@ -1,17 +0,0 @@
-/**
- * Start Mock Data
- *
- * Just some quick data as a Proof of Concept.
- * When continuing on this, we should extract it to a data folder,
- * and have helper functions for getting the data in the handlers below.
- */
-export interface Plant {
-    instCode: string;
-    hasTr2000: boolean;
-    description: string;
-    sapPlantId: string;
-    proCoSysPlantId: string;
-}
-export declare const mockedInstCodeName = "MockedInstCode";
-export declare const mockedSapPlantId = "1234";
-export declare const plants: Plant[];

package/src/lib/coreApplication/BarComponents/SelectionStatusDotIndicator.d.ts

@@ -1 +0,0 @@
-export declare function SelectionStatusDotIndicator(): import("react/jsx-runtime").JSX.Element | null;