@equinor/echo-framework 0.25.0 → 0.25.2

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

@@ -1,48 +1,85 @@
-export type FetchStatus = {
-    statusCode?: 'Forbidden' | number;
-};
-export type PlantReference = {
-    label: string;
-    typeLabel: string;
-};
-export type WorkOrderDetails = FetchStatus & {
+/**
+ *  TODO: This should be a common type/enum,
+ *        See endDateStatus.ts in echo-components.
+ *        They are the same but with different case
+ */
+type ExpirationStatus = 'Completed' | 'Expired' | 'WithinSevenDays' | 'EightDaysToOneMonth' | 'OneToThreeMonths' | 'ThreeToSixMonths' | 'SixToTwelveMonths' | 'InMoreThanOneYear' | 'Unknown';
+type WorkOrderUserStatus = 'PREP' | 'PRCO' | 'RDEX' | 'STRT' | 'RDOP' | 'Other';
+interface ContentReferencesDto {
+    label?: string | null;
+    typeLabel?: string | null;
+}
+export interface PrepViewWorkOrderDto {
     id: string;
-    plantId: string;
-    tagId: string;
-    tagPlantId: string;
-    tagCategory: string;
-    tagCategoryId: string;
+    plantId?: string | null;
+    tagId?: string | null;
+    tagPlantId?: string | null;
+    tagCategory?: string | null;
+    tagCategoryId?: string | null;
     orderType: string;
     activeStatusIds: string;
-    userStatus: string;
-    isActive: true;
-    personResponsible: string;
-    plannerGroupId: string;
-    workCenterId: string;
-    locationId: string;
-    changedDateTime: string;
-    createdDateTime: string;
-    requiredEndDateTime: string;
-    requiredEndDateStatus: string;
+    userStatus: WorkOrderUserStatus;
+    isActive: boolean;
+    personResponsible?: string | null;
+    plannerGroupId?: string | null;
+    workCenterId?: string | null;
+    locationId?: string | null;
+    changedDateTime?: string | null;
+    createdDateTime?: string | null;
+    requiredEndDateTime?: string | null;
+    requiredEndDateStatus: ExpirationStatus;
     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;
+    basicStartDateTime?: string | null;
+    basicFinishDateTime?: string | null;
+    basicFinishDateStatus?: ExpirationStatus;
+    basicFinishDateStatusDescription?: string | null;
+    maintenancePlanDate?: string | null;
+    maintenancePlantId?: string | null;
+    maintenancePlant?: string | null;
+    planningPlantId?: string | null;
+    planningPlant?: string | null;
+    priorityId?: string | null;
+    priority?: string | null;
+    revisionId?: string | null;
+    equipmentId?: string | null;
+    systemId?: string | null;
+    system?: string | null;
+    description?: string | null;
+    longText?: string | null;
+    instCode?: string | null;
+    sortField?: string | null;
+    maintenancePlantReference?: ContentReferencesDto;
+    planningPlantReference?: ContentReferencesDto;
+}
+export interface PrepViewWorkOrder {
+    id: string;
     description: string;
-    longText: string;
-    instCode: string;
-    sortField: string;
-    maintenancePlantReference: PlantReference;
-    planningPlantReference: PlantReference;
-};
+    orderType: string;
+    isActive: boolean;
+    workCenterId: string;
+    basicFinishDateStatus?: ExpirationStatus;
+    requiredEndDateTime?: string;
+    requiredEndDateStatus?: ExpirationStatus;
+    maintenancePlanDate?: string;
+    basicFinishDateTime?: string;
+    basicStartDateTime?: string;
+    planningPlant?: string;
+    maintenancePlant?: string;
+    plantId?: string;
+    instCode?: string;
+    tagId?: string;
+    tagCategory?: string;
+    activeStatusIds?: string;
+    personResponsible?: string;
+    locationId?: string;
+    plannerGroupId?: string;
+    system?: string;
+    systemId?: string;
+    createdDateTime?: string;
+    changedDateTime?: string;
+    priority?: string;
+    revisionId?: string;
+    equipmentId?: string;
+    longText?: string;
+}
+export {};

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

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

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

@@ -1,4 +1,4 @@
-export * from './useClosePanelByKey';
+export { useClosePanelByKey } from './useClosePanelByKey';
 export * from './useEchoHistory';
 export * from './useFetchInstCodeBySapPlantId';
 export { useInstCodeSafe } from './useInstCodeSafe';

package/src/lib/utils/handleErrors.d.ts

@@ -1,3 +1,4 @@
-export default function handleErrors(exception: Error | unknown, options?: {
+export declare function handleErrors(exception: Error | unknown, options?: {
     userFriendlyErrorMessage: string;
 }): void;
+export default handleErrors;

package/src/lib/feature/legend/legendUpdater.d.ts

@@ -1,3 +0,0 @@
-export declare function unsubscribeToLegendDataChanged(): void;
-export declare function subscribeToLegendDataChanged(): void;
-export declare const sleep: (ms: number) => Promise<unknown>;

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

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