@equinor/echo-framework 0.24.2 → 0.25.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/echo-framework",
-  "version": "0.24.2",
+  "version": "0.25.0",
   "peerDependencies": {
     "@equinor/echo-base": ">= 0.7.5 < 0.8.0",
     "@equinor/echo-components": ">= 0.12.4 < 0.13.0",

package/src/index.d.ts

@@ -9,6 +9,7 @@ export { useFetchPlantInfo } from './lib/components/requestAccess/hooks/fetchPla
 export { RequestProCoSysAccess } from './lib/components/requestAccess/RequestProCoSysAccess';
 export { RequestSapAccess } from './lib/components/requestAccess/RequestSapAccess';
 export { WorkOrderListItem } from './lib/components/workOrderListItem';
+export type { WorkOrderListItemData } from './lib/components/workOrderListItem/types/types';
 export * from './lib/coreApplication';
 export { fetchEquipmentFromApi } from './lib/feature/equipment/api/api-equipmentWithMeasuringPoints';
 export * from './lib/feature/equipment/index';
@@ -27,6 +28,7 @@ export * from './lib/feature/measuringPoint/index';
 export * from './lib/feature/measuringPoint/types/measuringPoint';
 export * from './lib/feature/openItemsIn3d';
 export { createEcho3dInternalLink } from './lib/feature/openItemsIn3d/logic/createEcho3dInternalLink';
+export { useOpenWorkOrder } from './lib/feature/workOrder/hooks/useOpenWorkOrder';
 export { WorkOrderContent } from './lib/feature/workOrder/WorkOrderContent';
 export { RegisteredHookName } from './lib/hooks/hookLibrary';
 export { useCloseActiveTopMenuAtBreakPoint } from './lib/hooks/useCloseActiveTopMenuAtBreakPoint';

package/src/lib/components/fullScreenButtons/FullScreenModeButton.d.ts

@@ -1,2 +1,4 @@
 import React from 'react';
-export declare const FullScreenModeButton: React.FC;
+export declare const FullScreenModeButton: React.FC<{
+    toolTipDisabled?: boolean;
+}>;

package/src/lib/components/plantSelector/plantSelectorHelper.d.ts

@@ -2,4 +2,3 @@ import { Plant } from '@equinor/echo-core';
 export type MinimalPlant = Pick<Plant, 'instCode' | 'description' | 'sapPlantId'>;
 export declare function filterPlant(plant: MinimalPlant, inputValue: string): boolean;
 export declare function formatPlantOptionText(plantName: string, plantId: string | null): string;
-export declare function handleAutoSelectOnFocus(autocompleteRef: React.RefObject<HTMLDivElement>): void;

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

@@ -1,3 +1,3 @@
-import { WorkOrderItem } from '@equinor/echo-components';
+import { WorkOrderListItemData } from '../../../workOrderListItem/types/types';
 import { WorkOrderDetails } from '../../types';
-export declare function mapWorkOrderDetailsToWorkOrderItem(details: WorkOrderDetails): WorkOrderItem;
+export declare function mapWorkOrderDetailsToWorkOrderItem(details: WorkOrderDetails): WorkOrderListItemData;

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

@@ -1,16 +1,3 @@
-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;
-    cardClassName?: string;
-    footer?: React.ReactNode;
-}
+import { WorkOrderListItemProps } from './types/types';
 declare function WorkOrderListItem(props: Readonly<WorkOrderListItemProps>): import("react/jsx-runtime").JSX.Element;
 export { WorkOrderListItem };

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

@@ -0,0 +1,2 @@
+import { BasicFinishDateProps } from '../types/types';
+export declare function BasicFinishDate(props: Readonly<BasicFinishDateProps>): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,2 @@
+import { ExtraIconsProps } from '../types/types';
+export declare function ExtraIcons(props: Readonly<ExtraIconsProps>): import("react/jsx-runtime").JSX.Element | undefined;

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

@@ -0,0 +1,2 @@
+import { OperationDateRangeProps } from '../types/types';
+export declare function OperationDateRange(props: Readonly<OperationDateRangeProps>): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,2 @@
+import { PM01HeaderDataProps } from '../types/types';
+export declare function PM01HeaderData(props: Readonly<PM01HeaderDataProps>): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,2 @@
+import { PM02HeaderDataProps } from '../types/types';
+export declare function PM02HeaderData(props: Readonly<PM02HeaderDataProps>): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,2 @@
+import { WorkOrderListItemProps } from '../types/types';
+export declare function WorkOrderHeaderDate({ workOrder, workOrderDateType }: WorkOrderListItemProps): import("react/jsx-runtime").JSX.Element | null;

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

@@ -0,0 +1,55 @@
+import { ColorMap, WorkOrderDateType } from '@equinor/echo-components';
+export interface WorkOrderListItemData {
+    description: string;
+    id: string;
+    isActive: boolean;
+    orderType: string;
+    workCenterId: string;
+    recordTypeIds: string[] | undefined;
+    hasB30Document: boolean | undefined;
+    hasPrts: boolean | undefined;
+    basicFinishDateStatus: string | undefined;
+    basicFinishDateTime: Date | undefined;
+    earlyFinishDate: Date | undefined;
+    earlyStartDate: Date | undefined;
+    maintenancePlanDate: Date | undefined;
+    maintenancePlant: string | undefined;
+    operationId: string | undefined;
+    planningPlant: string | undefined;
+    requiredEndDateStatus: string | undefined;
+    requiredEndDateTime: Date | undefined;
+}
+export interface WorkOrderListItemProps {
+    workOrder: WorkOrderListItemData;
+    onCardClick?: () => void;
+    itemAction?: React.ReactNode;
+    isHeader?: boolean;
+    colorMap?: ColorMap;
+    iconName?: string;
+    workOrderDateType?: WorkOrderDateType;
+    className?: string;
+    cardClassName?: string;
+    footer?: React.ReactNode;
+    isHighlightable?: boolean;
+}
+export type BasicFinishDateProps = {
+    readonly basicFinishDateStatus?: string;
+    readonly basicFinishDateTime?: Date;
+};
+export type OperationDateRangeProps = {
+    readonly earlyStartDate?: Date;
+    readonly earlyFinishDate?: Date;
+};
+export type PM02HeaderDataProps = {
+    readonly maintenancePlanDate?: Date;
+};
+export type PM01HeaderDataProps = {
+    readonly requiredEndDateStatus: string;
+    readonly requiredEndDateTime: Date;
+};
+export type ExtraIconsProps = {
+    readonly hasPrts?: boolean;
+    readonly operationId?: string;
+    readonly recordTypeIds?: string[];
+    readonly hasB30Document?: boolean;
+};

package/src/lib/components/workOrderListItem/utils/dates.d.ts

@@ -0,0 +1 @@
+export declare function getFullLocaleDatetime(date: Date | undefined): string | undefined;

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

@@ -109,7 +109,7 @@ export declare const globalSelectionApi: Readonly<{
          */
         addItems: (args: {
             itemIds: GlobalSelectionTypes.ItemId[];
-        } & import("./selectionMenu/selectionTreeStore/actions/selectionTree.action.types").AddByLabel) => void;
+        } & import("./selectionMenu/selectionTreeStore/actions/selectionTree.action.types").AddByGroupIdAndLabel) => void;
     }>;
     search: {
         /**
@@ -199,6 +199,7 @@ export declare const globalSelectionApi: Readonly<{
      */
     clearSelection: () => void;
     createGroup: (args: {
+        groupId: string;
         label: string;
         subLabel: string;
     }) => import("dist/libs/echo-utils/src").Guid;

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

@@ -1,7 +1,10 @@
 import { 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<ResultArray<T>[]>;
+type FetchFunction<T, U> = (itemIds: Readonly<U[]>) => Promise<{
+    result: ResultArray<T>;
+    itemIdsUsed: U[];
+}[]>;
 type NullItemGenerator<T, U> = (itemId: U) => T;
 type SetFunction = (set: (state: GlobalSelectionStore) => void, shouldReplace?: boolean | undefined, action?: string) => void;
 export declare function addItemsToSelectionFactory<T extends GlobalSelectionItemType>(args: {

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

@@ -33,7 +33,7 @@ export type GlobalSelectionObject = {
 export interface GlobalSelectionStoreData {
     lists: GlobalSelectionObject;
 }
-export type SelectionItemSystemStatus = 'isLoading' | 'notFound' | 'loadedSuccessfully';
+export type SelectionItemSystemStatus = 'isLoading' | 'notFound' | 'loadedSuccessfully' | 'error';
 export interface GlobalSelectionMetaData {
     color: string;
     isHiddenByUser: boolean;

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

@@ -15,11 +15,6 @@ import { GlobalSelectionItemType, GlobalSelectionTypes, SelectionItemSystemStatu
 export declare function convertGlobalSelectionItemsToPlantTagPairs(): Promise<PlantAndTagForOpenIn3d[]>;
 export declare function toGlobalSelectionItem<T extends GlobalSelectionTypes.ItemTypeToDataMap[K], K extends GlobalSelectionItemType>(item: T, type: K, systemStatus: SelectionItemSystemStatus): GlobalSelectionTypes.GenericItem<K>;
 export declare function toGlobalSelectionItems<T extends GlobalSelectionTypes.ItemTypeToDataMap[K], K extends GlobalSelectionItemType>(items: T[], type: K, systemStatus: SelectionItemSystemStatus): GlobalSelectionTypes.GenericItem<K>[];
-export declare function finalizeLoadStateByItemType<T extends GlobalSelectionItemType>(args: {
-    itemType: GlobalSelectionItemType;
-    state: GlobalSelectionTypes.Store;
-    itemDataToStore: GlobalSelectionTypes.ItemTypeToDataMap[T][];
-}): void;
 export declare function setNotFoundStatusByItemIds(args: {
     itemType: GlobalSelectionItemType;
     state: GlobalSelectionTypes.Store;

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

@@ -1,7 +1,8 @@
 import { ResultArray } from '@equinor/echo-search';
 import { GlobalSelectionItemType, GlobalSelectionItemTypeToDataMap, GlobalSelectionTypes, SelectionItemTypeToItemIdMap } from '../../../globalSelectionStore/globalSelectionStore.types';
 import { SelectionBase } from '../selectionTree.store.types';
-export type AddByLabel = SelectionBase | {
+export type AddByGroupIdAndLabel = SelectionBase | {
+    groupId?: undefined;
     label?: undefined;
     subLabel?: undefined;
 };
@@ -9,7 +10,7 @@ export type AddItemArgs<ItemIdType extends GlobalSelectionTypes.ItemId> = {
     itemIds: Readonly<ItemIdType[]>;
     replaceItems?: boolean;
     getActionResult?: boolean;
-} & AddByLabel;
+} & AddByGroupIdAndLabel;
 export type AddItemsResponse<T extends GlobalSelectionItemType> = {
     fetchResults: ResultArray<GlobalSelectionItemTypeToDataMap[T]>[];
     itemsAdded: Readonly<SelectionItemTypeToItemIdMap[T][]>;

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

@@ -1,6 +1,6 @@
 import { Guid } from '@equinor/echo-utils';
 import { GlobalSelectionItemType, GlobalSelectionTypes, SelectionItemTypeToItemIdMap } from '../../globalSelectionStore/globalSelectionStore.types';
-import { AddByLabel, AddItemArgs, AddItemsResponse, SelectionTreeActionResult } from './actions/selectionTree.action.types';
+import { AddByGroupIdAndLabel, AddItemArgs, AddItemsResponse, SelectionTreeActionResult } from './actions/selectionTree.action.types';
 export declare enum GlobalSelectionCategoryId {
     Tags = "DEFAULT_TAG_LIST_ID",
     WorkOrders = "DEFAULT_WORK_ORDER_LIST_ID",
@@ -13,6 +13,7 @@ export type SelectionTreeItem<T extends GlobalSelectionItemType> = {
     readonly type: T;
 };
 export interface SelectionBase {
+    readonly groupId: Guid;
     readonly label: string;
     readonly subLabel: string;
 }
@@ -27,11 +28,9 @@ export interface PersistedSelectionCategory {
     readonly items: SelectionTreeItem<GlobalSelectionItemType>[];
 }
 export interface SelectionGroup extends SelectionBase {
-    readonly id: Guid;
     readonly categories: SelectionCategory[];
 }
 export interface PersistedSelectionGroup extends SelectionBase {
-    readonly id: Guid;
     readonly categories: PersistedSelectionCategory[];
 }
 export interface SelectionTreeData {
@@ -41,12 +40,13 @@ export interface SelectionTreeStore {
     groups: SelectionGroup[];
     addItems: (args: {
         itemIds: GlobalSelectionTypes.ItemId[];
-    } & AddByLabel) => void;
+    } & AddByGroupIdAndLabel) => void;
     addTags: (args: AddItemArgs<GlobalSelectionTypes.TagId>) => AddTagsReturnType;
     addWorkOrders: (args: AddItemArgs<GlobalSelectionTypes.WorkOrderId>) => AddWorkOrdersReturnType;
     addEquipments: (args: AddItemArgs<GlobalSelectionTypes.EquipmentId>) => AddEquipmentsReturnType;
     addMeasuringPoints: (args: AddItemArgs<GlobalSelectionTypes.MeasuringPointId>) => AddMeasuringPointsReturnType;
     createGroup: (args: {
+        groupId: string;
         label: string;
         subLabel: string;
     }) => Guid;

package/src/lib/feature/openItemsIn3d/components/plantNoSelectionDialog/plantNoRadioList.d.ts

@@ -0,0 +1,9 @@
+import { Plant3dInfo, Plant3dInfoCount } from '../../logic/openItemsIn3d.utils';
+interface PlantNoRadioListProps {
+    title: string;
+    items: Plant3dInfoCount[];
+    selectedPlant: Plant3dInfo | undefined;
+    onSelect: (selectedPlant: Plant3dInfoCount) => void;
+}
+export declare const PlantNoRadioList: React.FC<PlantNoRadioListProps>;
+export {};

package/src/lib/feature/openItemsIn3d/{plantNoSelectionDialog.d.ts → components/plantNoSelectionDialog/plantNoSelectionDialog.d.ts}

@@ -1,4 +1,4 @@
-import { Plant3dInfo, PlantAndTagForOpenIn3d } from './logic/openItemsIn3d.utils';
+import { Plant3dInfo, PlantAndTagForOpenIn3d } from '../../logic/openItemsIn3d.utils';
 interface PlantNoSelectionDialogProps {
     getItems: () => Promise<PlantAndTagForOpenIn3d[]>;
     onPlantSelectionConfirmed: (selectedPlantNo: Plant3dInfo) => void;

package/src/lib/feature/openItemsIn3d/logic/getPlant.d.ts

@@ -0,0 +1,3 @@
+import { Plant } from '@equinor/echo-core';
+import { Plant3dInfo } from './openItemsIn3d.utils';
+export declare function getPlantFromPlant3dInfo(selectedPlant: Plant3dInfo): Promise<Plant | undefined>;

package/src/lib/feature/workOrder/WorkOrder.d.ts

@@ -0,0 +1,5 @@
+interface WorkOrderProps {
+    readonly workOrderId: string;
+}
+export declare const WorkOrder: React.FC<WorkOrderProps>;
+export {};

package/src/lib/feature/workOrder/api/api-preview-workOrder.d.ts

@@ -0,0 +1,6 @@
+import { WorkOrderDetails } from '../types/workOrder';
+interface WorkOrderRequest {
+    readonly workOrderId: string;
+}
+export declare function getPrepviewWorkOrderDetails(args: WorkOrderRequest): Promise<WorkOrderDetails>;
+export {};

package/src/lib/feature/workOrder/components/WorkOrderItemDetails.d.ts

@@ -0,0 +1,6 @@
+import { WorkOrderDetails } from '../types/workOrder';
+interface WorkOrderItemDetailsProps {
+    readonly data: WorkOrderDetails;
+}
+export declare const WorkOrderItemDetails: (props: WorkOrderItemDetailsProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/src/lib/feature/workOrder/components/WorkOrderItemHeader.d.ts

@@ -0,0 +1,10 @@
+import { WorkOrderDetails } from '../types/workOrder';
+interface WorkOrderHeaderProps {
+    /**
+     * TODO: We need to improve types on WorkOrderListItem before we Pick the actual properties we need for this component.
+     *       Until then we will continue with the original mapWorkOrderDetailsToWorkOrderItem.
+     */
+    readonly data: WorkOrderDetails;
+}
+export declare const WorkOrderItemHeader: (props: WorkOrderHeaderProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/src/lib/feature/workOrder/hooks/useOpenWorkOrder.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @deprecated Don't use this hook, it is under development and not ready for production use.
+ * Use openWorkOrderDetails() instead.
+ */
+export declare function useOpenWorkOrder(): (args: {
+    workOrderId: string;
+    panelKey?: string;
+    keepLastNavigationItem?: boolean;
+}) => void;

package/src/lib/feature/workOrder/hooks/usePrepviewWorkOrder.d.ts

@@ -0,0 +1,6 @@
+import { WorkOrderDetails } from '../types/workOrder';
+export declare function usePrepviewWorkOrder(workOrderId: string): {
+    isLoading: boolean;
+    error: Error | null;
+    workOrder?: WorkOrderDetails;
+};

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

@@ -0,0 +1,48 @@
+export type FetchStatus = {
+    statusCode?: 'Forbidden' | number;
+};
+export type PlantReference = {
+    label: string;
+    typeLabel: string;
+};
+export type WorkOrderDetails = FetchStatus & {
+    id: string;
+    plantId: string;
+    tagId: string;
+    tagPlantId: string;
+    tagCategory: string;
+    tagCategoryId: string;
+    orderType: string;
+    activeStatusIds: string;
+    userStatus: string;
+    isActive: true;
+    personResponsible: string;
+    plannerGroupId: string;
+    workCenterId: string;
+    locationId: string;
+    changedDateTime: string;
+    createdDateTime: string;
+    requiredEndDateTime: string;
+    requiredEndDateStatus: string;
+    requiredEndDateStatusDescription: string;
+    basicStartDateTime: string;
+    basicFinishDateTime: string;
+    basicFinishDateStatus: string;
+    basicFinishDateStatusDescription: string;
+    maintenancePlanDate: string;
+    maintenancePlant: string;
+    planningPlantId: string;
+    planningPlant: string;
+    priorityId: string;
+    priority: string;
+    revisionId: string;
+    equipmentId: string;
+    systemId: string;
+    system: string;
+    description: string;
+    longText: string;
+    instCode: string;
+    sortField: string;
+    maintenancePlantReference: PlantReference;
+    planningPlantReference: PlantReference;
+};

package/src/lib/feature/workOrder/utils/workOrderUtils.d.ts

@@ -0,0 +1,3 @@
+import { WorkOrderListItemData } from '../../../components/workOrderListItem/types/types';
+import { WorkOrderDetails } from '../types/workOrder';
+export declare function mapWorkOrderDetailsToWorkOrderItem(details: WorkOrderDetails): WorkOrderListItemData;

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

@@ -1 +1,2 @@
 export declare const echopediaAnalyticsModule: import("@equinor/echo-core").AnalyticsModule;
+export declare function trackEventOpenExternalLink(linkTo: string): void;