@equinor/echo-framework 0.9.22 → 0.10.0-r18-beta-2

package/dist/components/prepview/types/document.d.ts

@@ -0,0 +1,13 @@
+import { FileDto } from '@equinor/echo-search';
+export type PrepviewDocumentGroup = {
+    type: string;
+    documents: Array<PrepviewDocument>;
+};
+export type PrepviewDocument = {
+    docNo: string;
+    docTitle: string;
+    files: Array<FileDto>;
+    revDate: Date;
+    revNo: string;
+    revStatus: string;
+};

package/dist/components/prepview/types/index.d.ts

@@ -0,0 +1,9 @@
+export * from './attachment';
+export * from './common';
+export * from './document';
+export * from './notification';
+export * from './operation';
+export * from './punch';
+export * from './safety';
+export * from './tag';
+export * from './workorder';

package/dist/components/prepview/types/notification.d.ts

@@ -0,0 +1,68 @@
+import { PrepviewAttachment } from './attachment';
+import { FetchStatus } from './common';
+import { PrepviewDocumentGroup } from './document';
+import { PrepviewPunch } from './punch';
+import { PrepviewSafety } from './safety';
+import { PrepviewTagInformation } from './tag';
+import { PrepviewTagHistoryGroup, PrepviewWorkOrder } from './workorder';
+export type PrepviewNotificationDto = {
+    details: NotificationDetails;
+    additionalDetails?: NotificationAdditionalDetails;
+};
+export type NotificationDetails = FetchStatus & {
+    id: string;
+    type: string;
+    title: string;
+    tagPlantId: string;
+    tagId: string;
+    plantId: string;
+    createdDateTime: Date;
+    requiredEndDateTime: Date;
+    maintenancePlant: string;
+    planningPlant: string;
+    activeStatusIds: string;
+    unsafeFailureMode: string;
+    plannerGroup: string;
+    mainWorkCenter: string;
+    failureImpact: string;
+    priorityId: string;
+    priority: string;
+    failureMode: string;
+    detectionMethodId: string;
+    failureMechanism: string;
+    longText: string;
+};
+export type NotificationAdditionalDetails = {
+    attachments: FetchStatus & {
+        attachments: Array<PrepviewAttachment>;
+    };
+    documents: FetchStatus & {
+        documentGroups: Array<PrepviewDocumentGroup>;
+    };
+    history: FetchStatus & {
+        notificationGroups: FetchStatus & {
+            groups: PrepviewTagHistoryGroup<PrepviewNotification>[];
+        };
+        punchGroups: FetchStatus & {
+            groups: PrepviewTagHistoryGroup<PrepviewPunch>[];
+        };
+        workOrderGroups: FetchStatus & {
+            groups: PrepviewTagHistoryGroup<PrepviewWorkOrder>[];
+        };
+    };
+    safetyCards: FetchStatus & {
+        safetyCards: Array<PrepviewSafety>;
+    };
+    tagInformation: FetchStatus & PrepviewTagInformation;
+};
+export type PrepviewNotification = {
+    id: string;
+    activeStatusIds: string;
+    changedDateTime?: Date;
+    createdDateTime: Date;
+    planningPlant: string;
+    mainWorkCenterId: string;
+    requiredEndDateTime: Date;
+    title: string;
+    type: string;
+};

package/dist/components/prepview/types/operation.d.ts

@@ -0,0 +1,13 @@
+export type PrepviewOperation = {
+    actualPercentageComplete: number;
+    actualWorkHours: string;
+    capacityCount: number;
+    activeStatusIds: string;
+    earliestFinishDateTime: Date;
+    earliestStartDateTime: Date;
+    operationNumber: string;
+    plannedDuration: string;
+    plannedWorkHours: string;
+    title: string;
+    workCenterId: string;
+};

package/dist/components/prepview/types/punch.d.ts

@@ -0,0 +1,27 @@
+import { FetchStatus } from './common';
+export type PunchDetails = FetchStatus & {
+    id: string;
+    tagNo: string;
+    tagDescription: string;
+    tagArea: string;
+    description: string;
+    statusId: string;
+    mcPkgNo: string;
+    commPkgNo: string;
+    systemId: number;
+    clearedByOrg: string;
+    raisedByOrg: string;
+    typeDescription: string;
+    priorityId: string;
+    projectName: string;
+    statusCode: number;
+};
+export type PrepviewPunch = {
+    id: string;
+    type: string;
+    statusId: string;
+    tagNo: string;
+    tagArea: string;
+    description: string;
+    updatedAt?: Date;
+};

package/dist/components/prepview/types/safety.d.ts

@@ -0,0 +1,21 @@
+export type PrepviewSafety = {
+    title: string;
+    description: string;
+    caseDate: string;
+    country: string;
+    url: string;
+    severity: number;
+};
+export interface SafetyDataParams {
+    dateFrom: string;
+    dateTo: string;
+    filters: SafetyDataFilter[];
+    query: string;
+    sortByDate: boolean;
+    top: number;
+}
+interface SafetyDataFilter {
+    fieldName: string;
+    values: string[];
+}
+export {};

package/dist/components/prepview/types/tag.d.ts

@@ -0,0 +1,24 @@
+export type PrepviewTagInformation = {
+    abcIndicator: string;
+    area: string;
+    consequenceCost: string;
+    consequenceFail: string;
+    consequenceHse: string;
+    consequenceProd: string;
+    criticalSparepartDemandTime?: Date;
+    functionalLocation: string;
+    id: string;
+    location: string;
+    overallCriticality: string;
+    redundancy: string;
+    repairStrategy: string;
+    unsafeFailure: string[];
+};
+export type PrepviewRelatedTag = {
+    tagId: string;
+    tagPlantId: string;
+    tag: string;
+    notification?: string;
+    equipment?: string;
+    description?: string;
+};

package/dist/components/prepview/types/workorder.d.ts

@@ -0,0 +1,82 @@
+import { PrepviewAttachment } from './attachment';
+import { FetchStatus } from './common';
+import { PrepviewDocumentGroup } from './document';
+import { PrepviewNotification } from './notification';
+import { PrepviewOperation } from './operation';
+import { PrepviewPunch } from './punch';
+import { PrepviewSafety } from './safety';
+import { PrepviewRelatedTag, PrepviewTagInformation } from './tag';
+export type PrepviewWorkOrderDto = {
+    details: WorkOrderDetails;
+    additionalDetails?: WorkOrderAdditionalDetails;
+};
+export type WorkOrderDetails = FetchStatus & {
+    basicFinishDateTime: Date;
+    basicStartDateTime: Date;
+    changedDateTime: Date;
+    createdDateTime: Date;
+    requiredEndDateTime: Date;
+    maintenancePlanDate: Date;
+    maintenancePlant: string;
+    planningPlant: string;
+    activeStatusIds: string;
+    description: string;
+    equipmentId: string;
+    id: string;
+    locationId: string;
+    longText: string;
+    tagId: string;
+    workCenterId: string;
+    personResponsible?: string;
+    revisionId?: string;
+    orderType: string;
+    plannerGroupId: string;
+    systemId: string;
+    system: string;
+    priority: string;
+    priorityId: string;
+    plantId: string;
+};
+export type WorkOrderAdditionalDetails = {
+    attachments: FetchStatus & {
+        attachments: Array<PrepviewAttachment>;
+    };
+    documents: FetchStatus & {
+        documentGroups: Array<PrepviewDocumentGroup>;
+    };
+    history: FetchStatus & {
+        notificationGroups: FetchStatus & {
+            groups: PrepviewTagHistoryGroup<PrepviewNotification>[];
+        };
+        punchGroups: FetchStatus & {
+            groups: PrepviewTagHistoryGroup<PrepviewPunch>[];
+        };
+        workOrderGroups: FetchStatus & {
+            groups: PrepviewTagHistoryGroup<PrepviewWorkOrder>[];
+        };
+    };
+    objects: FetchStatus & {
+        objects: Array<PrepviewRelatedTag>;
+    };
+    operations: FetchStatus & {
+        operations: Array<PrepviewOperation>;
+    };
+    safetyCards: FetchStatus & {
+        safetyCards: Array<PrepviewSafety>;
+    };
+    tagInformation: FetchStatus & PrepviewTagInformation;
+};
+export type PrepviewTagHistoryGroup<T = PrepviewNotification | PrepviewWorkOrder | PrepviewPunch> = {
+    type: string;
+    items: Array<T>;
+};
+export type PrepviewWorkOrder = {
+    type: string;
+    title: string;
+    mainWorkCenterId?: string;
+    id: string;
+    createdDateTime: Date;
+    changedDateTime: Date;
+    activeStatusIds: string;
+    tagNo: string;
+};

package/dist/components/prepview/utils/date.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Returns a date as a friendly readable string. If the date is undefined, it returns empty string.
+ * @param date The date to convert to friendly string format.
+ */
+export declare function dateToStringOrEmpty(date: Date | string | undefined): string;

package/dist/components/prepview/utils/documents.d.ts

@@ -0,0 +1 @@
+export declare function setFileIcon(fileExtension: string | undefined): string;

package/dist/components/prepview/utils/dom.d.ts

@@ -0,0 +1 @@
+export declare function escapeSpecialCharacters(text: string): string[];

package/dist/components/prepview/utils/enums/documents.d.ts

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

package/dist/components/prepview/utils/enums/index.d.ts

@@ -0,0 +1,2 @@
+export * from './documents';
+export * from './tagHistoryItem';

package/dist/components/prepview/utils/enums/tagHistoryItem.d.ts

@@ -0,0 +1,5 @@
+export declare enum WorkItemType {
+    Notifications = 0,
+    WorkOrders = 1,
+    Punches = 2
+}

package/dist/components/prepview/utils/index.d.ts

@@ -0,0 +1,10 @@
+export * from './date';
+export * from './documents';
+export * from './dom';
+export * from './enums';
+export * from './logger';
+export * from './object';
+export * from './string';
+export * from './url';
+export * from './workorder';
+export * from './notification';

package/dist/components/prepview/utils/logger.d.ts

@@ -0,0 +1,71 @@
+import { AnalyticsEvent, AnalyticsModule } from '@equinor/echo-core';
+export declare enum ObjectName {
+    Module = "Module",
+    Synergi = "Synergi",
+    SafeX = "SafeX"
+}
+type ActionNames = {
+    [ObjectName.Module]: ModuleActions;
+    [ObjectName.Synergi]: SynergiActions;
+    [ObjectName.SafeX]: SafeXActions;
+};
+type ActionProperties = {
+    [ObjectName.Module]: ModuleActionProperties;
+    [ObjectName.Synergi]: SynergiActionProperties;
+    [ObjectName.SafeX]: SafeXActionProperties;
+};
+type ModuleActions = 'Started';
+type ModuleActionProperties = {
+    message?: string;
+};
+type SynergiActions = 'Application opened';
+type SynergiActionProperties = {
+    synergiUrl: string;
+};
+type SafeXActions = 'Application opened';
+type SafeXActionProperties = {
+    searchValue?: string;
+};
+declare enum LogLevel {
+    Invalid = 0,
+    LocalDevelopment = 1,
+    EchoDevelopment = 2,
+    QA = 3,
+    Prod = 4
+}
+type LogLevelKeys = keyof typeof LogLevel;
+interface BaseLoggerProps {
+    moduleName: string;
+    analytics: AnalyticsModule;
+    /**
+     * LogLevelOverride can be set in localstorage as "[moduleShortName].logOverride"
+     * and should be a number between 0 and 5.
+     */
+    logLevelOverride?: LogLevel;
+}
+declare class BaseLogger {
+    protected _moduleName: string;
+    protected _logLevel: LogLevel;
+    protected _logLevelOverride?: LogLevel;
+    protected _analytics: AnalyticsModule;
+    constructor({ moduleName, analytics, logLevelOverride }: BaseLoggerProps);
+    set overrideLogLevel(override: LogLevelKeys);
+    getLogLevelOverride(): number;
+    track(event: AnalyticsEvent): void;
+    trackError(error: Error): void;
+    log(level: LogLevelKeys, callback: () => void): void;
+    /**
+     * @returns LogLevel for current hosting environment.
+     */
+    protected setInitialLogLevel(): LogLevel;
+}
+type PrepviewLoggerProps = BaseLoggerProps;
+declare class PrepviewLogger extends BaseLogger {
+    constructor({ ...baseProps }: PrepviewLoggerProps);
+    trackEvent<Name extends ObjectName = ObjectName, Action extends ActionNames[Name] = ActionNames[Name], Properties extends ActionProperties[Name] = ActionProperties[Name]>(objectName: Name, actionName: Action, properties: Properties): void;
+    moduleStarted(): void;
+    synergiOpened(props: SynergiActionProperties): void;
+    openSafeX(props: SafeXActionProperties): void;
+}
+declare const logger: PrepviewLogger;
+export { logger };

package/dist/components/prepview/utils/notification.d.ts

@@ -0,0 +1,3 @@
+export declare function setNotificationIconName(type: string): "notifications_m1" | "notifications_m2" | "notifications_m3" | "notifications_m4" | "notifications_m5" | "notifications_m6" | "notifications_m9" | "notifications_main_group";
+export declare function getStatusColor(statusIds: string): "#4bb748" | "#fbca36";
+export declare function getStatusText(statusIds: string): "Completed" | "Active";

package/dist/components/prepview/utils/object.d.ts

@@ -0,0 +1 @@
+export declare const toStringOrDefault: <T, K extends keyof T>(target: T, key: K, defaultValue?: string) => string;

package/dist/components/prepview/utils/punch.d.ts

@@ -0,0 +1 @@
+export declare function setPunchIconName(type: string): "punches_pa" | "punches_pb" | "punches_main_group";

package/dist/components/prepview/utils/string.d.ts

@@ -0,0 +1 @@
+export declare function trimToLength(inputString: string, stringLength: number): string;

package/dist/components/prepview/utils/url.d.ts

@@ -0,0 +1,9 @@
+export declare function combineUrls(base: string, ...parts: string[]): string;
+export type Params = Record<string, string | number | boolean>;
+/**
+ * Takes a url as input and adds the specified parameters to it.
+ * @param url The url to extend.
+ * @param params The params to add.
+ */
+export declare const addParams: (url: string, params: Params) => string;
+export declare function openUrl(url: string): void;

package/dist/components/prepview/utils/workorder.d.ts

@@ -0,0 +1,2 @@
+export declare const MaintenanceApiNameForWorkOrders: Record<string, string>;
+export declare function setWorkOrderIconName(type: string): "workorders_pm01" | "workorders_pm02" | "workorders_pm03" | "workorders_pm04" | "workorders_pm05" | "workorders_pm06" | "workorders_pm10" | "workorders_pm15" | "workorders_pm20" | "workorders_main_group";

package/dist/components/prepview/workorder/details/DetailsWorkOrder.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import type { WorkOrderDetails } from '../../types';
+export interface Props {
+    details: WorkOrderDetails;
+    instCode: string;
+    isLoading?: boolean;
+    closePanel: () => void;
+}
+declare function DetailsWorkOrder({ details, instCode, closePanel }: Props): JSX.Element;
+export { DetailsWorkOrder };

package/dist/components/prepview/workorder/details/index.d.ts

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

package/dist/components/prepview/workorder/header/Header.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+import { WorkOrderDetails } from '../../types';
+interface HeaderProps {
+    instCode: string;
+    workOrder: WorkOrderDetails;
+    workOrderHeaderAction?: React.ReactNode;
+}
+declare function Header(props: HeaderProps): JSX.Element | null;
+export { Header };

package/dist/components/prepview/workorder/header/index.d.ts

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

package/dist/components/prepview/workorder/index.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import { PrepviewWorkOrderDto } from '../types';
+interface WorkOrderProps {
+    instCode: string;
+    workOrder: PrepviewWorkOrderDto;
+    closePanel: () => void;
+    workOrderHeaderAction?: React.ReactNode;
+}
+declare function WorkOrder(props: WorkOrderProps): JSX.Element | null;
+export { WorkOrder };

package/dist/components/realTimeData/hooks/useRealTimeHub.d.ts

@@ -4,7 +4,7 @@ interface RealTimeData extends SignalRState {
     metadata?: IMSByName;
     present?: SignalRData;
 }
-declare type SignalRData = {
+type SignalRData = {
     time: Date;
     value: number;
     status: number;

package/dist/components/realTimeData/hooks/useSignalRListener.d.ts

@@ -1,4 +1,4 @@
 import { HubConnection } from '@microsoft/signalr';
-declare type HubMethod = (...args: any[]) => void;
+type HubMethod = (...args: any[]) => void;
 export declare function useSignalRListener(hubConnection: HubConnection | undefined, target: string, method: HubMethod): void;
 export {};

package/dist/components/router/echoRoute.d.ts

@@ -1,9 +1,8 @@
 import { AppComponentProps, WrappedComponent } from '@equinor/echo-core';
 import React, { ErrorInfo } from 'react';
-import { LayoutProps } from '../containers/layouts';
 interface EchoRouteProps {
     component: WrappedComponent<AppComponentProps>;
-    layout: React.FC<LayoutProps>;
+    layoutKey?: string;
     path: string;
     errorHandler?: (error: Error, errorInfo: ErrorInfo) => void;
     exactPath?: boolean;

package/dist/components/router/index.d.ts

@@ -1,4 +1,3 @@
 export * from './echoRoute';
 export * from './echoRouter';
 export * from './routes';
-export * from './useLayout';

package/dist/components/tagNumber/tagNumber.d.ts

@@ -2,6 +2,7 @@
 interface TagNoProps {
     tagNo: string;
     className?: string;
+    replaceLastNavigationItem?: boolean;
 }
-export declare const TagNumber: ({ tagNo, className }: TagNoProps) => JSX.Element;
-export default TagNumber;
+export declare const TagNumber: ({ tagNo, className, replaceLastNavigationItem }: TagNoProps) => JSX.Element;
+export {};

package/dist/coreApplication/EchoBarComponent.d.ts

@@ -0,0 +1,17 @@
+import React from 'react';
+interface EchoBottomBarProps {
+    isBottomBarVisible: boolean;
+    activeAppMenuItem: string;
+    updateActiveAppMenuItem: (newActiveAppMenuItem: string) => void;
+}
+interface EchoBottomBarButtonProps {
+    name: string;
+    isActive: boolean;
+    onButtonClick: (name: string) => void;
+    label?: string;
+    iconClassName?: string;
+}
+export declare const EchoBottomBarButton: React.FC<EchoBottomBarButtonProps>;
+export declare const EchoBarComponent: React.FC<EchoBottomBarProps>;
+declare const _default: React.NamedExoticComponent<EchoBottomBarProps>;
+export default _default;

package/dist/coreApplication/EchoContent.d.ts

@@ -1,7 +1,6 @@
 import React from 'react';
 interface CorePanelsProps {
     children: React.ReactNode;
-    isLeftAndRightPanelHidden?: boolean;
     Legend?: React.FC;
 }
 export declare const EchoContent: React.FC<CorePanelsProps>;

package/dist/coreApplication/EchoSetup.d.ts

@@ -1,6 +1,6 @@
 import { Panel } from '@equinor/echo-core';
 import React, { ComponentType } from 'react';
-export declare type AnyComponent<T> = ComponentType<T>;
+export type AnyComponent<T> = ComponentType<T>;
 export interface EchoApp {
     authenticated: boolean;
 }

package/dist/coreApplication/EchoUserInterfaceContextProvider.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+interface EchoUiContextState {
+    activeAppMenuItem: string;
+    isLegendActive: boolean | undefined;
+    updateActiveAppMenuItem: (newActiveAppMenuItem: string) => void;
+    updateIsLegendActive: (isLegendActive: boolean) => void;
+}
+export declare const useEchoUiContext: () => EchoUiContextState;
+interface EchoUiContextProviderProps {
+    children: React.ReactNode;
+}
+export declare const EchoUiContextProvider: React.FC<EchoUiContextProviderProps>;
+export {};

package/dist/coreApplication/index.d.ts

@@ -1,3 +1,5 @@
+export * from './EchoBarComponent';
 export * from './EchoContent';
 export * from './EchoContentPanels';
 export * from './EchoEventHandler';
+export * from './EchoUserInterfaceContextProvider';