@equinor/echo-framework 0.10.1 → 0.10.3

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

@@ -0,0 +1,80 @@
+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';
+export declare type PrepviewWorkOrderDto = {
+    details: WorkOrderDetails;
+    additionalDetails?: WorkOrderAdditionalDetails;
+};
+export declare type FetchStatus = {
+    statusCode?: 'Forbidden' | string;
+};
+export declare type WorkOrderDetails = FetchStatus & {
+    basicFinishDateTime: Date;
+    basicStartDateTime: Date;
+    changedDateTime: Date;
+    createdDateTime: Date;
+    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 declare 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 declare type PrepviewTagHistoryGroup<T = PrepviewNotification | PrepviewWorkOrder | PrepviewPunch> = {
+    type: string;
+    items: Array<T>;
+};
+export declare 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,8 @@
+export * from './enums';
+export * from './date';
+export * from './documents';
+export * from './dom';
+export * from './workorder';
+export * from './logger';
+export * from './object';
+export * from './url';

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"
+}
+declare type ActionNames = {
+    [ObjectName.Module]: ModuleActions;
+    [ObjectName.Synergi]: SynergiActions;
+    [ObjectName.SafeX]: SafeXActions;
+};
+declare type ActionProperties = {
+    [ObjectName.Module]: ModuleActionProperties;
+    [ObjectName.Synergi]: SynergiActionProperties;
+    [ObjectName.SafeX]: SafeXActionProperties;
+};
+declare type ModuleActions = 'Started';
+declare type ModuleActionProperties = {
+    message?: string;
+};
+declare type SynergiActions = 'Application opened';
+declare type SynergiActionProperties = {
+    synergiUrl: string;
+};
+declare type SafeXActions = 'Application opened';
+declare type SafeXActionProperties = {
+    searchValue?: string;
+};
+declare enum LogLevel {
+    Invalid = 0,
+    LocalDevelopment = 1,
+    EchoDevelopment = 2,
+    QA = 3,
+    Prod = 4
+}
+declare 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;
+}
+declare 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/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/url.d.ts

@@ -0,0 +1,8 @@
+export declare function combineUrls(base: string, ...parts: string[]): string;
+export declare 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;

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

@@ -0,0 +1 @@
+export declare const MaintenanceApiNameForWorkOrders: Record<string, string>;

package/dist/components/prepview/workorder/additionalDetails/AdditionalDetails.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import type { WorkOrderAdditionalDetails, WorkOrderDetails } from '../../types';
+interface Props {
+    instCode: string;
+    details: WorkOrderDetails;
+    additionalDetails: WorkOrderAdditionalDetails;
+}
+declare function AdditionalDetails({ instCode, details, additionalDetails }: Props): JSX.Element;
+export { AdditionalDetails };

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

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

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

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

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

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

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

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