@equinor/echo-framework 0.23.2 → 0.23.4-beta-0

package/src/lib/feature/globalSelection/selectionMenu/selectionTreeStore/selectionTree.store.types.d.ts

@@ -1,22 +1,12 @@
-import { ResultArray, TagSummaryDto } from '@equinor/echo-search';
 import { Guid } from '@equinor/echo-utils';
-import { GlobalSelectionItemType, GlobalSelectionTypes } from '../../globalSelectionStore/globalSelectionStore.types';
+import { GlobalSelectionItemType, GlobalSelectionTypes, SelectionItemTypeToItemIdMap } from '../../globalSelectionStore/globalSelectionStore.types';
 import { AddByLabel, AddItemArgs, AddItemsResponse, SelectionTreeActionResult } from './actions/selectionTree.action.types';
-export type SelectionItemTypeToItemIdMap = {
-    [GlobalSelectionItemType.Tag]: GlobalSelectionTypes.TagId;
-    [GlobalSelectionItemType.WorkOrder]: GlobalSelectionTypes.WorkOrderId;
-    [GlobalSelectionItemType.Equipment]: GlobalSelectionTypes.EquipmentId;
-};
 export declare enum GlobalSelectionCategoryId {
     Tags = "DEFAULT_TAG_LIST_ID",
-    WorkOrders = "DEFAULT_WORK_ORDER_LIST_ID"
+    WorkOrders = "DEFAULT_WORK_ORDER_LIST_ID",
+    Equipments = "DEFAULT_EQUIPMENT_LIST_ID"
 }
 export declare const globalSelectionDefaultGroupId: Guid;
-/**  @deprecated Use GlobalSelectionCategoryId instead */
-export declare enum SelectionMenuDefaultListIds {
-    TagList = "DEFAULT_TAG_LIST_ID",
-    WorkOrderList = "DEFAULT_WORK_ORDER_LIST_ID"
-}
 export type SelectionTreeItem<T extends GlobalSelectionItemType> = {
     id: SelectionItemTypeToItemIdMap[T];
     type: T;
@@ -48,13 +38,12 @@ export interface SelectionTreeData {
 }
 export interface SelectionTreeStore {
     groups: SelectionGroup[];
-    addTags: <T extends boolean | undefined = undefined>(args: AddItemArgs<GlobalSelectionTypes.TagId> & {
-        getActionResult?: T;
-    }) => Promise<AddTagsReturnType<T>>;
-    addWorkOrders: (args: AddItemArgs<GlobalSelectionTypes.WorkOrderId>) => void;
     addItems: (args: {
         itemIds: GlobalSelectionTypes.ItemId[];
     } & AddByLabel) => void;
+    addTags: (args: AddItemArgs<GlobalSelectionTypes.TagId>) => AddTagsReturnType;
+    addWorkOrders: (args: AddItemArgs<GlobalSelectionTypes.WorkOrderId>) => AddWorkOrdersReturnType;
+    addEquipments: (args: AddItemArgs<GlobalSelectionTypes.EquipmentId>) => AddEquipmentsReturnType;
     createGroup: (args: {
         label: string;
         subLabel: string;
@@ -86,4 +75,6 @@ export declare namespace SelectionTreeTypes {
     type Group = SelectionGroup;
     type ActionResult = SelectionTreeActionResult;
 }
-export type AddTagsReturnType<T extends boolean | undefined = undefined> = T extends true ? AddItemsResponse<ResultArray<TagSummaryDto>[]> : ResultArray<TagSummaryDto>[];
+export type AddTagsReturnType = Promise<AddItemsResponse<GlobalSelectionItemType.Tag>>;
+export type AddWorkOrdersReturnType = Promise<AddItemsResponse<GlobalSelectionItemType.WorkOrder>>;
+export type AddEquipmentsReturnType = Promise<AddItemsResponse<GlobalSelectionItemType.Equipment>>;

package/src/lib/feature/hooks/useAddTagToLegendRegistry.d.ts

@@ -6,7 +6,7 @@ import { LegendItemStatus } from '../legacyLegend';
  * Adds one given tag item to the legend registry service, which tracks the legend status of the registered items.
  * Returns with the updated itemIdToStatusMap, which contains this newly added item by id as well.
  *
- * @param {string} tagId The given tag's id to be stored in the registry.
+ * @param {string} tagNo The given tag's id to be stored in the registry.
  * @returns {Record<string, LegendItemStatus>} A legend status map: keys are the item ids, values are the legend statuses.
  */
-export declare function useAddTagToLegendRegistry(tagId: string): Record<string, LegendItemStatus>;
+export declare function useAddTagToLegendRegistry(tagNo: string): Record<string, LegendItemStatus>;

package/src/lib/utils/highlightTextUtil.d.ts

@@ -0,0 +1,26 @@
+/**
+ * CSS class name to be added to components that should be highlightable.
+ *
+ * @example
+ * // Add this class to the `className` of a component to make it highlightable.
+ * <div className={highlightableComponentCssClass}>...</div>
+ */
+export declare const highlightableComponentCssClass = "highlightableComponentCssClass";
+/**
+ * Highlights text within elements that have the `highlightableComponentCssClass` class.
+ *
+ * This function uses the `mark.js` library to highlight text matching the `search` query parameter
+ * in the URL. It applies the `highlightedText` CSS class to the matched text. The styling for
+ * `highlightedText` should be defined in `./public/index.css`.
+ *
+ * @example
+ * // Add the following to a React component to enable text highlighting:
+ * useEffect(() => {
+ *     highlightText();
+ * }, []);
+ *
+ * @remarks
+ * - The `search` query parameter is retrieved using `getLinkParams` from `@equinor/echo-utils`.
+ * - Punctuation characters are ignored during the matching process.
+ */
+export declare const highlightText: () => void;

package/src/lib/utils/index.d.ts

@@ -1,5 +1,6 @@
 export { echopediaWebReactPortalUtils } from './echopediaWebReactPortal.utils';
 export * from './formatTimeHelpers';
+export * from './highlightTextUtil';
 export * from './navigationUtils';
 export * from './openIn3d';
 export * from './plantInfo';

package/src/lib/utils/stringUtils.d.ts

@@ -1 +1,6 @@
+/**
+ * @deprecated This is a duplicate, we plan to remove this. Please use the same function from "@equinor/echo-utils".
+ * @param inputString
+ * @returns {string}
+ */
 export declare function removeLeadingZeros(inputString: string): string;

package/src/lib/feature/globalSelection/globalSelectionStore/actions/addItemsToSelection.action.d.ts

@@ -1,18 +0,0 @@
-import { ResultArray } from '@equinor/echo-search';
-import { StoreApi } from 'zustand';
-import { GlobalSelectionItemType, GlobalSelectionItemTypeToDataMap, GlobalSelectionStore, GlobalSelectionTypes } from '../globalSelectionStore.types';
-type FetchFunction<T, U> = (itemIds: Readonly<U[]>) => Promise<ResultArray<T>[]>;
-type NullItemGenerator<T, U> = (itemId: U) => T;
-type ItemIdTypeMap = {
-    [GlobalSelectionItemType.WorkOrder]: GlobalSelectionTypes.WorkOrderId;
-    [GlobalSelectionItemType.Tag]: GlobalSelectionTypes.TagId;
-    [GlobalSelectionItemType.Equipment]: GlobalSelectionTypes.EquipmentId;
-};
-type SetFunction = (set: (state: GlobalSelectionStore) => void, shouldReplace?: boolean | undefined, action?: string) => void;
-export declare function addItemsToSelection<T extends GlobalSelectionItemType>(set: SetFunction, get: StoreApi<GlobalSelectionStore>['getState'], args: {
-    itemIds: ItemIdTypeMap[T][];
-}, itemType: T, fetchFunction: FetchFunction<GlobalSelectionItemTypeToDataMap[T], ItemIdTypeMap[T]>, nullItemGenerator: NullItemGenerator<GlobalSelectionItemTypeToDataMap[T], ItemIdTypeMap[T]>): Promise<{
-    fetchResult: ResultArray<GlobalSelectionItemTypeToDataMap[T]>[];
-    actionResult: GlobalSelectionTypes.ActionResult;
-}>;
-export {};

package/src/lib/feature/globalSelection/globalSelectionStore/globalSelectionNullItems.d.ts

@@ -1,4 +0,0 @@
-import { WorkOrderData } from '@equinor/echo-search';
-import { GlobalSelectionTypes } from './globalSelectionStore.types';
-export declare function createNullTagSummaryDb(itemId: GlobalSelectionTypes.TagId): GlobalSelectionTypes.TagDto;
-export declare function createNullWorkOrderData(itemId: GlobalSelectionTypes.WorkOrderId): WorkOrderData;