@equinor/echo-framework 6.2.2 → 6.2.3

package/src/lib/feature/workOrder/components/WorkOrderPanelObjects/components/WorkOrderObjectItem.d.ts

@@ -2,5 +2,5 @@ import { PrepviewWorkOrderObject } from '../types/workOrder-objects';
 interface WorkOrderObjectItemProps {
     object: PrepviewWorkOrderObject;
 }
-export declare const WorkOrderObjectItem: (props: WorkOrderObjectItemProps) => import("react/jsx-runtime").JSX.Element;
+export declare const WorkOrderObjectItem: (props: WorkOrderObjectItemProps) => import("react").JSX.Element;
 export {};

package/src/lib/feature/workOrder/components/WorkOrderPanelOperations/WorkOrderPanelOperations.d.ts

@@ -1,5 +1,5 @@
 interface WorkOrderPanelOperationsProps {
     readonly workOrderId: string;
 }
-export declare const WorkOrderPanelOperations: ({ workOrderId }: WorkOrderPanelOperationsProps) => import("react/jsx-runtime").JSX.Element;
+export declare const WorkOrderPanelOperations: ({ workOrderId }: WorkOrderPanelOperationsProps) => import("react").JSX.Element;
 export {};

package/src/lib/feature/workOrder/components/WorkOrderPanelOperations/components/WorkOrderOperationItem.d.ts

@@ -2,5 +2,5 @@ import { PrepviewWorkOrderOperation } from '../types/workOrder-operations';
 interface WorkOrderOperationItemProps {
     readonly operation: PrepviewWorkOrderOperation;
 }
-export declare const WorkOrderOperationItem: (props: WorkOrderOperationItemProps) => import("react/jsx-runtime").JSX.Element;
+export declare const WorkOrderOperationItem: (props: WorkOrderOperationItemProps) => import("react").JSX.Element;
 export {};

package/src/lib/feature/workOrder/components/WorkOrderPanelOperations/components/WorkOrderOperationItemHeader.d.ts

@@ -7,5 +7,5 @@ interface WorkOrderOperationItemHeaderProps {
     earliestStartDateTime?: Date;
     earliestFinishDateTime?: Date;
 }
-export declare const WorkOrderOperationItemHeader: (props: WorkOrderOperationItemHeaderProps) => import("react/jsx-runtime").JSX.Element;
+export declare const WorkOrderOperationItemHeader: (props: WorkOrderOperationItemHeaderProps) => import("react").JSX.Element;
 export {};

package/src/lib/feature/workOrder/components/WorkOrderPanelSafeX/WorkOrderPanelSafeX.d.ts

@@ -1,5 +1,5 @@
 interface WorkOrderPanelSafeXProps {
     readonly workOrderId: string;
 }
-export declare const WorkOrderPanelSafeX: ({ workOrderId }: WorkOrderPanelSafeXProps) => import("react/jsx-runtime").JSX.Element;
+export declare const WorkOrderPanelSafeX: ({ workOrderId }: WorkOrderPanelSafeXProps) => import("react").JSX.Element;
 export {};

package/src/lib/feature/workOrder/components/WorkOrderPanelSafeX/components/SSUListItem/SSUListItem.d.ts

@@ -2,5 +2,5 @@ import { PrepViewSafetyCard } from '../../types/workOrder-safetyCards';
 interface SSUListItemProps {
     readonly data: PrepViewSafetyCard;
 }
-export declare const SSUListItem: (props: SSUListItemProps) => import("react/jsx-runtime").JSX.Element;
+export declare const SSUListItem: (props: SSUListItemProps) => import("react").JSX.Element;
 export {};

package/src/lib/feature/workOrder/components/WorkOrderPanelSafeX/components/SSUListItem/SSUListItemMarker.d.ts

@@ -1,5 +1,5 @@
 interface SSUListItemMarkerProps {
     readonly severity: number;
 }
-declare function SSUListItemMarker({ severity }: SSUListItemMarkerProps): import("react/jsx-runtime").JSX.Element;
+declare function SSUListItemMarker({ severity }: SSUListItemMarkerProps): import("react").JSX.Element;
 export { SSUListItemMarker };

package/src/lib/feature/workPermit/hooks/useWorkPermitStatuses.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Fetches the work-permit statuses for every tag in the currently selected plant.
+ *
+ * Returns a `tagNo -> statuses[]` dictionary so downstream consumers can read the
+ * statuses synchronously (via React 19 `use`) without triggering a fetch per work order.
+ *
+ * The promise is cached per `instCode` in the logic layer so `use` receives a stable
+ * reference and only suspends once per plant. The cache is cleared on plant change via
+ * `clearCachedWorkPermitStatuses`.
+ */
+export declare function useWorkPermitStatuses(): Readonly<Record<string, readonly string[]>>;

package/src/lib/feature/workPermit/logic/workPermit.d.ts

@@ -0,0 +1,8 @@
+import { WorkPermitStatusesByTagNo } from '../../../services/api/workPermits.types';
+export declare function clearCachedWorkPermitStatuses(): void;
+export declare function getWorkPermitsTagStatusesOrCached(instCode: string): Promise<WorkPermitStatusesByTagNo>;
+/**
+ * Returns a stable promise reference per `instCode` so it can be passed to React 19 `use`.
+ * Returns an empty-map promise (without fetching) when no plant is selected.
+ */
+export declare function getWorkPermitsTagStatusesStablePromise(instCode: string): Promise<WorkPermitStatusesByTagNo>;

package/src/lib/services/api/api-open-work-orders-by-tag-nos.d.ts

@@ -0,0 +1,14 @@
+import { TagNo, WorkOrderDto } from '@equinor/echo-search';
+/**
+ * Fetches open work orders for multiple tags using echo-search.
+ * Throws via `resultHelper.throwIfError` when the search result contains errors.
+ *
+ * @param tagNos - Array of tag numbers to search open work orders for
+ * @returns Promise resolving to an array of open work orders
+ *
+ * @example
+ * ```typescript
+ * const workOrders = await fetchOpenWorkOrdersByTagNos(['23-PV-1234', '23-XV-5678']);
+ * ```
+ */
+export declare function fetchOpenWorkOrdersByTagNos(tagNos: ReadonlyArray<TagNo>): Promise<ReadonlyArray<WorkOrderDto>>;

package/src/lib/services/api/api-workPermits.d.ts

@@ -0,0 +1,8 @@
+import { RequestTagWorkPermits, WorkPermit, WorkPermitTagNoStatuses } from './workPermits.types';
+/**
+ * Fetches work permits for a given tag from back end API
+ */
+export declare function getWorkPermitsForTagApi({ instCode, tagNo, customErrorHandling }: RequestTagWorkPermits): Promise<WorkPermit[] | undefined>;
+export declare function fetchWorkPermitsStatusesForAllTagsApi(args: {
+    instCode: string;
+}): Promise<WorkPermitTagNoStatuses[]>;

package/src/lib/services/api/index.d.ts

@@ -1,3 +1,4 @@
 export * from './api-plantinfo';
 export { getTagDetails } from './api-tag-details';
 export * from './api-tag-list-for-3D';
+export type { FunctionalLocationId } from './workPermits.types';

package/src/lib/services/api/workPermits.types.d.ts

@@ -0,0 +1,27 @@
+import { TagNo } from '@equinor/echo-search';
+export interface RequestTagWorkPermits {
+    readonly tagNo: TagNo | undefined;
+    readonly instCode: string;
+    readonly customErrorHandling: boolean | undefined;
+}
+export interface WorkPermit {
+    readonly workPermitId: string;
+    readonly title: string;
+    readonly workOrderId: string | undefined;
+    readonly workDescription: string;
+    readonly workType: string;
+    readonly status: WorkPermitStatus;
+    readonly createdDateTime: Date;
+}
+export type WorkPermitStatus = 'Draft' | 'Closed' | 'Expired' | 'Released' | 'Draft for Shutdown' | 'Awaiting Preapproval';
+export interface FunctionalLocationId {
+    readonly functionalLocationId: string;
+}
+export interface WorkPermitStatuses extends FunctionalLocationId {
+    readonly statuses: ReadonlyArray<WorkPermitStatus>;
+}
+export interface WorkPermitTagNoStatuses {
+    readonly tagNo: TagNo;
+    readonly statuses: ReadonlyArray<WorkPermitStatus>;
+}
+export type WorkPermitStatusesByTagNo = Readonly<Record<TagNo, ReadonlyArray<string>>>;

package/src/lib/services/cache/cacheTypes.d.ts

@@ -0,0 +1,3 @@
+export interface Arguments {
+    [key: string]: string | string[] | number | boolean | undefined;
+}

package/src/lib/services/cache/taskCache.d.ts

@@ -0,0 +1,24 @@
+export interface CachedTaskItem<T> {
+    task: Promise<T>;
+    key: string;
+    timeToLiveMilliseconds?: number;
+    maxHits?: number;
+}
+interface InternalCachedTaskItem<T> extends CachedTaskItem<T> {
+    timeStamp: Date;
+}
+export interface CacheOptions {
+    maxItems: number;
+    defaultTimeToLiveMilliseconds: number;
+}
+export declare class TaskCache {
+    cache: InternalCachedTaskItem<unknown>[];
+    cacheOptions: CacheOptions;
+    constructor(cacheOptions: CacheOptions);
+    add<T>(item: CachedTaskItem<T>): void;
+    get<T>(key: string): CachedTaskItem<T> | undefined;
+    clear(): void;
+    private clearExpired;
+    private removeItem;
+}
+export {};

package/src/lib/services/cache/taskCacheRunner.d.ts

@@ -0,0 +1,10 @@
+import { Arguments } from './cacheTypes';
+interface TaskCacheRunner {
+    clear(): void;
+    runTaskOrCached<R, Arg extends Arguments>(task: (argument: Arg) => Promise<R>, argument: Arg): Promise<R>;
+}
+export declare function createTaskCacheRunner(args?: {
+    maxItems?: number;
+    defaultTimeToLiveMilliseconds?: number;
+}): TaskCacheRunner;
+export {};

package/src/lib/types/grid/bucketSideDrawer.types.d.ts

@@ -1,2 +1,2 @@
-export type BucketPanelKey = 'turnaround' | 'sharedWithMe' | 'project';
-export type BucketSourceKey = 'Turnaround grid' | 'Project grid';
+export type BucketPanelKey = 'turnaround' | 'sharedWithMe' | 'project' | 'workOrders';
+export type BucketSourceKey = 'Turnaround grid' | 'Project grid' | 'Work Orders grid';

package/src/lib/feature/legend/hooks/useWorkOrdersByTagNos.d.ts

@@ -1,11 +0,0 @@
-import { WorkOrderDto } from '@equinor/echo-search';
-interface TagNoWithWorkOrders {
-    readonly tagNo: string;
-    readonly openWorkOrders: ReadonlyArray<WorkOrderDto>;
-}
-export declare function useOpenWorkOrdersByTagNos(items: ReadonlyArray<{
-    tagNo: string;
-}>): {
-    tagNosWithOpenWorkOrders: readonly TagNoWithWorkOrders[];
-};
-export {};

package/src/lib/feature/legend/hooks/useWorkOrdersByTagsQuery.d.ts

@@ -1,15 +0,0 @@
-import { WorkOrderDto } from '@equinor/echo-search';
-/**
- * Fetches work orders for multiple tags using React Query.
- *
- * @param tagNos - Array of tag numbers to search work orders for
- * @returns React Query result with work orders data, loading state, and error state
- *
- * @example
- * ```typescript
- * const tagNos = ['23-PV-1234', '23-XV-5678'];
- * const { data: workOrders = [], isLoading, error } = useWorkOrdersByTagsQuery(tagNos);
- * ```
- *
- */
-export declare function useWorkOrdersByTagsQuery(tagNos: string[]): import("@tanstack/react-query").UseQueryResult<NoInfer<readonly WorkOrderDto[]>, Error>;

package/src/lib/feature/legend/legendStrategies/workOrderStrategy/useCreateWorkOrderMarkers.d.ts

@@ -1,20 +0,0 @@
-import { RawMarkerData } from '../../types/legendMarkerBadge.type';
-import { LegendDataId } from '../../types/legendType';
-/**
- * // TODO: #426625 - Fix marker and badge appearances to be based on work order properties instead of hardcoded values.
- *
- * Creates raw legend marker data for work orders grouped by `tagId`.
- *
- * The hook:
- * \- filters `itemIds` to tag selections,
- * \- searches work orders by `tagNo`,
- * \- groups results by `tagId`,
- * \- maps each group to a purple marker with orange badges (one per work order).
- *
- * Badge titles are derived from `workOrderId` using `removeLeadingZeros`.
- * DisplayKeys and highlight colors are computed in useLegendMarker.
- *
- * @param itemIds \- Current legend selection ids.
- * @returns An array of `RawMarkerData` objects, or an empty array when no data is available.
- */
-export declare const useCreateWorkOrderMarkers: (itemIds: ReadonlyArray<LegendDataId>) => ReadonlyArray<RawMarkerData>;

package/src/lib/feature/legend/legendStrategies/workOrderStrategy/workOrderPopover.types.d.ts

@@ -1,15 +0,0 @@
-import { LegendDataId } from '../../types/legendType';
-export type PopoverProps = {
-    legendDataId: LegendDataId;
-    itemIds?: ReadonlyArray<LegendDataId>;
-};
-export interface WorkOrderPopover {
-    readonly workOrderId: string;
-    readonly isActive: boolean;
-    readonly orderTypeId: string;
-    readonly description: string;
-    readonly plantNo: string;
-    readonly workCenter: string;
-    readonly basicFinishDateTime: Date | undefined;
-    readonly basicFinishDateStatus: string | undefined;
-}

package/src/lib/services/api/api-work-orders-by-tag-nos.d.ts

@@ -1,15 +0,0 @@
-import { WorkOrderDto } from '@equinor/echo-search';
-/**
- * Fetches work orders for multiple tags using echo-search.
- * Wraps the echo-search API call for use with React Query.
- * Throws via `resultHelper.throwIfError` when the search result contains errors.
- *
- * @param tagNos - Array of tag numbers to search work orders for
- * @returns Promise resolving to array of work orders
- *
- * @example
- * ```typescript
- * const workOrders = await fetchWorkOrdersByTagNos(['23-PV-1234', '23-XV-5678']);
- * ```
- */
-export declare function fetchWorkOrdersByTagNos(tagNos: ReadonlyArray<string>): Promise<ReadonlyArray<WorkOrderDto>>;