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

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

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

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

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { NotificationDetails } from '../../types';
+interface HeaderProps {
+    instCode: string;
+    notification: NotificationDetails;
+}
+declare function Header(props: HeaderProps): JSX.Element | null;
+export { Header };

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

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

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

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { PrepviewNotificationDto } from '../types';
+interface NotificationProps {
+    instCode: string;
+    notification: PrepviewNotificationDto;
+    closePanel: () => void;
+}
+declare function Notification(props: NotificationProps): JSX.Element | null;
+export { Notification };

package/dist/components/prepview/panels/attachments/Attachments.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import type { PrepviewAttachment } from '../../types';
+interface Props {
+    recordType: string;
+    recordId: string;
+    attachments: PrepviewAttachment[];
+}
+declare function AttachmentsPanel({ recordType, recordId, attachments }: Props): JSX.Element;
+export { AttachmentsPanel };

package/dist/components/prepview/panels/attachments/index.d.ts

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

package/dist/components/prepview/panels/history/TagHistory.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { PrepviewNotification, PrepviewPunch, PrepviewTagHistoryGroup, PrepviewWorkOrder } from '../../types';
+interface HistoryProps {
+    notificationGroups: PrepviewTagHistoryGroup<PrepviewNotification>[];
+    workOrderGroups: PrepviewTagHistoryGroup<PrepviewWorkOrder>[];
+    punchGroups: PrepviewTagHistoryGroup<PrepviewPunch>[];
+}
+declare function TagHistoryPanel({ notificationGroups, workOrderGroups, punchGroups }: HistoryProps): JSX.Element;
+export { TagHistoryPanel };

package/dist/components/prepview/panels/history/group/TagHistoryGroup.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import { PrepviewNotification, PrepviewPunch, PrepviewTagHistoryGroup, PrepviewWorkOrder } from '../../../types';
+import { WorkItemType } from '../../../utils';
+interface Props {
+    emptyText: string;
+    workItemType: WorkItemType;
+    groups: PrepviewTagHistoryGroup<PrepviewNotification | PrepviewWorkOrder | PrepviewPunch>[];
+}
+declare function TagHistoryGroup({ groups, emptyText, workItemType }: Props): JSX.Element;
+export { TagHistoryGroup };

package/dist/components/prepview/panels/history/group/index.d.ts

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

package/dist/components/prepview/panels/history/horizontalView/HorizontalTagHistory.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+import { PrepviewNotification, PrepviewPunch, PrepviewTagHistoryGroup, PrepviewWorkOrder } from '../../../types';
+interface HorizontalTagHistoryProps {
+    notificationGroups: PrepviewTagHistoryGroup<PrepviewNotification>[];
+    workOrderGroups: PrepviewTagHistoryGroup<PrepviewWorkOrder>[];
+    punchGroups: PrepviewTagHistoryGroup<PrepviewPunch>[];
+}
+declare const HorizontalTagHistory: React.FC<HorizontalTagHistoryProps>;
+export { HorizontalTagHistory };

package/dist/components/prepview/panels/history/horizontalView/index.d.ts

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

package/dist/components/prepview/panels/history/index.d.ts

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

package/dist/components/prepview/panels/history/items/Items.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import { PrepviewNotification, PrepviewPunch, PrepviewWorkOrder } from '../../../types';
+import { WorkItemType } from '../../../utils';
+type Items = Array<PrepviewNotification | PrepviewWorkOrder | PrepviewPunch>;
+export interface ItemProps {
+    itemType: WorkItemType;
+    subType: string;
+    items: Items;
+}
+declare const Items: React.FC<ItemProps>;
+export { Items };

package/dist/components/prepview/panels/history/items/NotificationItem.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { PrepviewNotification } from '../../../types';
+interface NotificationItemProps {
+    notification: PrepviewNotification;
+}
+declare const NotificationItem: React.FC<NotificationItemProps>;
+export { NotificationItem };

package/dist/components/prepview/panels/history/items/PunchItem.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { PrepviewPunch } from '../../../types';
+interface PunchProps {
+    punch: PrepviewPunch;
+}
+declare const PunchItem: React.FC<PunchProps>;
+export { PunchItem };

package/dist/components/prepview/panels/history/items/WorkOrderItem.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { PrepviewWorkOrder } from '../../../types';
+interface WorkOrderItemProps {
+    workOrder: PrepviewWorkOrder;
+}
+declare const WorkOrderItem: React.FC<WorkOrderItemProps>;
+export { WorkOrderItem };

package/dist/components/prepview/panels/history/items/index.d.ts

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

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

@@ -0,0 +1,7 @@
+export * from './attachments';
+export * from './operations';
+export * from './tagDocumentRefs';
+export * from './tagInformation';
+export * from './objects';
+export * from './risk';
+export * from './history';

package/dist/components/prepview/panels/objects/Objects.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { PrepviewRelatedTag } from '../../types';
+interface Props {
+    relatedTags: PrepviewRelatedTag[];
+}
+declare function ObjectsPanel({ relatedTags }: Props): JSX.Element;
+export { ObjectsPanel };

package/dist/components/prepview/panels/objects/index.d.ts

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

package/dist/components/prepview/panels/operations/Operations.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { PrepviewOperation } from '../../types';
+interface Props {
+    operations: PrepviewOperation[];
+}
+declare function OperationsPanel({ operations }: Props): JSX.Element;
+export { OperationsPanel };

package/dist/components/prepview/panels/operations/index.d.ts

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

package/dist/components/prepview/panels/risk/Risk.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { PrepviewSafety } from '../../types';
+interface RiskTabProps {
+    safetyCards: PrepviewSafety[];
+}
+declare function RiskPanel({ safetyCards }: RiskTabProps): JSX.Element;
+export { RiskPanel };

package/dist/components/prepview/panels/risk/index.d.ts

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

package/dist/components/prepview/panels/risk/trafficLight/TrafficLight.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+interface TrafficLightProps {
+    severity: number;
+    children?: React.ReactNode;
+}
+declare function TrafficLight({ severity, children }: TrafficLightProps): JSX.Element;
+export { TrafficLight };

package/dist/components/prepview/panels/risk/trafficLight/index.d.ts

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

package/dist/components/prepview/panels/tagDocumentRefs/HorizontalDocumentGroups.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { PrepviewDocumentGroup } from '../../types';
+interface HorizontalDocumentGroupsProps {
+    instCode: string;
+    documentGroups: Array<PrepviewDocumentGroup>;
+    tagNo: string;
+}
+declare function HorizontalDocumentGroups({ instCode, documentGroups, tagNo }: HorizontalDocumentGroupsProps): JSX.Element;
+export { HorizontalDocumentGroups };

package/dist/components/prepview/panels/tagDocumentRefs/TagDocumentGroup.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import type { PrepviewDocument } from '../../types';
+interface TagDocumentGroupProps {
+    instCode: string;
+    docType: string;
+    documents: PrepviewDocument[];
+    tagNo: string;
+}
+declare function TagDocumentGroup({ instCode, docType, documents, tagNo }: TagDocumentGroupProps): JSX.Element;
+export { TagDocumentGroup };

package/dist/components/prepview/panels/tagDocumentRefs/TagDocumentItem.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { PrepviewDocument } from '../../types';
+interface TagDocumentItemProps {
+    instCode: string;
+    document: PrepviewDocument;
+    tagNo: string;
+}
+declare function TagDocumentItem({ instCode, document, tagNo }: TagDocumentItemProps): JSX.Element;
+export { TagDocumentItem };

package/dist/components/prepview/panels/tagDocumentRefs/TagDocumentRefs.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import type { PrepviewDocumentGroup } from '../../types';
+interface Props {
+    instCode: string;
+    documentGroups: Array<PrepviewDocumentGroup>;
+    tagNo: string;
+}
+declare function TagDocumentRefsPanel({ documentGroups, instCode, tagNo }: Props): JSX.Element;
+export { TagDocumentRefsPanel };

package/dist/components/prepview/panels/tagDocumentRefs/index.d.ts

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

package/dist/components/prepview/panels/tagInformation/TagInformation.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+import { PrepviewTagInformation } from '../../types';
+interface Props {
+    tagInformation: PrepviewTagInformation;
+}
+/**
+ * TagInformationPanel
+ * this panel requires the user to have maintenance access to show data.
+ */
+declare function TagInformationPanel({ tagInformation }: Props): JSX.Element;
+export { TagInformationPanel };

package/dist/components/prepview/panels/tagInformation/index.d.ts

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

package/dist/components/prepview/punch/details/Details.d.ts

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

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

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

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

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { PunchDetails } from '../../types';
+interface HeaderProps {
+    instCode: string;
+    punch: PunchDetails;
+}
+declare function Header(props: HeaderProps): JSX.Element | null;
+export { Header };

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

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

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

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { PunchDetails } from '../types';
+interface PunchProps {
+    instCode: string;
+    punch: PunchDetails;
+    closePanel: () => void;
+}
+declare function Punch(props: PunchProps): JSX.Element | null;
+export { Punch };

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

@@ -0,0 +1,7 @@
+export type PrepviewAttachment = {
+    createdDateTime: Date;
+    fileName: string;
+    fileSize: number;
+    id: string;
+    statusCode?: string;
+};

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

@@ -0,0 +1,50 @@
+/// <reference types="react" />
+import { PrepviewAttachment } from './attachment';
+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';
+import { PrepviewTagHistoryGroup, PrepviewWorkOrder } from './workorder';
+export type FetchStatus = {
+    statusCode?: 'Forbidden' | string;
+};
+export type ContentPickerGroup = {
+    title?: string;
+    items: ContentPickerItem[];
+};
+export type ContentPickerItem = {
+    id: string;
+    title: string;
+    content: React.ReactNode;
+};
+export type AdditionalDetailsDto = {
+    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;
+};

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';