@equinor/echo-framework 0.10.1 → 0.10.3

package/dist/__tests__/prepviewUtils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/containers/layouts.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-export declare type LayoutKey = 'main' | 'nativePdf' | 'colorLayout' | undefined;
+export declare type LayoutKey = 'main' | 'nativePdf' | 'colorLayout' | '3dweb' | undefined;
 export interface LayoutProps {
     layoutKey?: string;
     children: React.ReactNode;

package/dist/components/index.d.ts

@@ -14,6 +14,7 @@ export * from './panelButton';
 export * from './plantSelector';
 export * from './projectSelector';
 export * from './realTimeData';
+export * from './prepview';
 export * from './router';
 export * from './searchMenu';
 export * from './tagNumber';

package/dist/components/prepview/Prepview.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+interface PrepviewProps {
+    instCode: string;
+    workOrder?: string;
+    notification?: string;
+    punch?: string;
+}
+declare function Prepview(props: PrepviewProps): JSX.Element | null;
+export { Prepview };
+export { MaintenanceApiNameForWorkOrders } from './utils';

package/dist/components/prepview/api/api.d.ts

@@ -0,0 +1,4 @@
+import { PrepviewWorkOrderDto } from '../types';
+import * as workOrderApi from './workorder';
+export { workOrderApi };
+export declare function getWorkOrder(instCode: string, workOrderId: string): Promise<PrepviewWorkOrderDto>;

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

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

package/dist/components/prepview/api/resources.d.ts

@@ -0,0 +1,2 @@
+export declare function getWorkOrder(instCode: string, workOrderId: string): string;
+export declare function getWorkorderAttachmentFile(orderTypeId: string, workorderId: string, attachmentId: string): string;

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

@@ -0,0 +1,2 @@
+import { WorkOrderDetails, PrepviewAttachment } from '../types';
+export declare function getAttachmentFile(workorder: WorkOrderDetails, attachment: PrepviewAttachment): Promise<Blob>;

package/dist/components/prepview/common/access/handler/StatusHandler.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { FetchStatus } from '../../../types';
+interface Props {
+    statusCode: FetchStatus['statusCode'];
+    children: React.ReactNode;
+}
+declare function StatusHandler({ statusCode, children }: Props): JSX.Element;
+export { StatusHandler };

package/dist/components/prepview/common/access/handler/index.d.ts

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

package/dist/components/prepview/common/access/index.d.ts

@@ -0,0 +1,2 @@
+export * from './handler';
+export * from './request';

package/dist/components/prepview/common/access/request/RequestAccess.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+declare type RequestAccessProps = {
+    padding?: boolean;
+};
+declare const RequestAccess: React.FC<RequestAccessProps>;
+export { RequestAccess };

package/dist/components/prepview/common/access/request/index.d.ts

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

package/dist/components/prepview/common/collapsiblePanel/CollapsiblePanel.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+interface CollapsablePanelType {
+    label?: string;
+    maxHeightCollapsed?: number;
+    noPadding?: boolean;
+    isExpandedDefault?: boolean;
+    children: JSX.Element | string[] | string;
+}
+declare function CollapsiblePanel({ label, maxHeightCollapsed, noPadding, isExpandedDefault, children }: CollapsablePanelType): JSX.Element;
+export { CollapsiblePanel };

package/dist/components/prepview/common/collapsiblePanel/index.d.ts

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

package/dist/components/prepview/common/details/accordion/DetailsAccordion.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { AccordionProps } from '@equinor/eds-core-react';
+interface DetailsAccordionProps {
+    headerLevel?: AccordionProps['headerLevel'];
+    children: React.ReactNode[];
+}
+declare function DetailsAccordion({ headerLevel, children }: DetailsAccordionProps): JSX.Element;
+export { DetailsAccordion };

package/dist/components/prepview/common/details/accordion/index.d.ts

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

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

@@ -0,0 +1,3 @@
+export * from './accordion';
+export * from './loader';
+export * from './panel';

package/dist/components/prepview/common/details/loader/DetailsLoader.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+declare function DetailsLoader(): JSX.Element | null;
+export { DetailsLoader };

package/dist/components/prepview/common/details/loader/index.d.ts

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

package/dist/components/prepview/common/details/panel/DetailsPanel.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+interface Props {
+    title: string;
+    children: React.ReactNode;
+    isLoading?: boolean;
+    buttonBar?: React.ReactNode;
+}
+declare function DetailsPanel({ title, isLoading, buttonBar, children }: Props): JSX.Element;
+export { DetailsPanel };

package/dist/components/prepview/common/details/panel/EmptyDetailsPanel.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+interface EmptyDetailsPanelProps {
+    text: string;
+}
+declare function EmptyDetailsPanel({ text }: EmptyDetailsPanelProps): JSX.Element;
+export { EmptyDetailsPanel };

package/dist/components/prepview/common/details/panel/description/PanelDescription.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+interface PanelDescriptionProps {
+    children?: React.ReactNode;
+}
+declare function PanelDescription({ children }: PanelDescriptionProps): JSX.Element;
+export { PanelDescription };

package/dist/components/prepview/common/details/panel/description/index.d.ts

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

package/dist/components/prepview/common/details/panel/index.d.ts

@@ -0,0 +1,3 @@
+export * from './DetailsPanel';
+export * from './EmptyDetailsPanel';
+export * from './description';

package/dist/components/prepview/common/fileSizeDisplay/FileSizeDisplay.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+import { FileDto } from '@equinor/echo-search';
+interface FileSizeDisplayProps {
+    files: FileDto[];
+    fileType?: 'pdf';
+    viewCode?: 'v';
+    className?: string;
+}
+declare function FileSizeDisplay({ files, fileType, viewCode, className }: FileSizeDisplayProps): JSX.Element | null;
+declare function formatBytes(bytes: number, decimals?: number): string;
+export { FileSizeDisplay, formatBytes };

package/dist/components/prepview/common/fileSizeDisplay/index.d.ts

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

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

@@ -0,0 +1,5 @@
+export * from './access';
+export * from './collapsiblePanel';
+export * from './details';
+export * from './fileSizeDisplay';
+export * from './info';

package/dist/components/prepview/common/info/block/InfoBlock.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+interface InfoBlockType {
+    label: string;
+    stretched?: boolean;
+    children: JSX.Element | string[] | string | number;
+}
+declare function InfoBlock({ label, stretched, children }: InfoBlockType): JSX.Element;
+export { InfoBlock };

package/dist/components/prepview/common/info/block/index.d.ts

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

package/dist/components/prepview/common/info/index.d.ts

@@ -0,0 +1,2 @@
+export * from './block';
+export * from './section';

package/dist/components/prepview/common/info/section/InfoSection.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+interface InfoSectionProps {
+    children?: React.ReactNode;
+}
+declare function InfoSection({ children }: InfoSectionProps): JSX.Element;
+export { InfoSection };

package/dist/components/prepview/common/info/section/index.d.ts

@@ -0,0 +1,2 @@
+export * from './InfoSection';
+export * from './longText';

package/dist/components/prepview/common/info/section/longText/LongTextSection.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+interface Props {
+    text: string;
+}
+declare function LongTextSection({ text }: Props): JSX.Element;
+export { LongTextSection };

package/dist/components/prepview/common/info/section/longText/index.d.ts

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

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

@@ -0,0 +1,2 @@
+export * from './useFetch';
+export * from './useOnClickDownload';

package/dist/components/prepview/hooks/useFetch.d.ts

@@ -0,0 +1,4 @@
+import { DependencyList } from 'react';
+declare type FetchCallback<T> = () => Promise<T> | undefined;
+export declare function useFetch<TError = unknown, T = unknown>(callback: FetchCallback<T>, deps?: DependencyList): [data: T | undefined, isLoading: boolean, error: TError | unknown];
+export {};

package/dist/components/prepview/hooks/useOnClickDownload.d.ts

@@ -0,0 +1,9 @@
+declare type DownloadPromise = () => Promise<Blob>;
+interface DownloadOnClick {
+    isLoading: boolean;
+    objectUrl?: string;
+    error?: unknown;
+    downloadOnClick: () => Promise<void>;
+}
+declare function useOnClickDownload(downloadBlob: DownloadPromise, fileName?: string): DownloadOnClick;
+export { useOnClickDownload };

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

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

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

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import type { PrepviewAttachment, WorkOrderDetails } from '../../types';
+interface Props {
+    workorder: WorkOrderDetails;
+    attachments: PrepviewAttachment[];
+    isLoading?: boolean;
+}
+declare function AttachmentsPanel({ workorder, attachments, isLoading }: 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/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 { WorkItemType } from '../../../utils';
+import { PrepviewNotification, PrepviewWorkOrder, PrepviewPunch } from '../../../types';
+declare 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,8 @@
+/// <reference types="react" />
+import { PrepviewSafety } from '../../types';
+interface RiskTabProps {
+    safetyCards: PrepviewSafety[];
+    searchValue?: string;
+}
+declare function RiskPanel({ safetyCards, searchValue }: RiskTabProps): JSX.Element;
+export { RiskPanel };

package/dist/components/prepview/panels/risk/actions/RiskActions.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+interface RiskActionProps {
+    searchValue?: string;
+}
+declare function RiskActions({ searchValue }: RiskActionProps): JSX.Element;
+export { RiskActions };

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

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

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

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

package/dist/components/prepview/panels/risk/item/RiskItem.d.ts

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

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

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

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/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/UnsafeFailure.d.ts

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

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

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

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

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

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

@@ -0,0 +1,13 @@
+import { FileDto } from '@equinor/echo-search';
+export declare type PrepviewDocumentGroup = {
+    type: string;
+    documents: Array<PrepviewDocument>;
+};
+export declare 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,8 @@
+export * from './attachment';
+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,10 @@
+export declare type PrepviewNotification = {
+    id: string;
+    activeStatusIds: string;
+    changedDateTime?: Date;
+    createdDateTime: Date;
+    mainWorkCenterId: string;
+    requiredEndDateTime: Date;
+    title: string;
+    type: string;
+};

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

@@ -0,0 +1,12 @@
+export declare type PrepviewOperation = {
+    actualPercentageComplete: number;
+    actualWorkHours: string;
+    capacityCount: number;
+    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,8 @@
+export declare type PrepviewPunch = {
+    id: string;
+    type: string;
+    tagNo: string;
+    tagArea: string;
+    description: string;
+    updatedAt?: Date;
+};

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

@@ -0,0 +1,21 @@
+export declare 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 declare 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 declare type PrepviewRelatedTag = {
+    tagId: string;
+    tagPlantId: string;
+    tag: string;
+    notification?: string;
+    equipment?: string;
+    description?: string;
+};