@topconsultnpm/sdkui-react 6.19.0-hotfix.3

package/lib/helper/helpers.d.ts

@@ -0,0 +1,92 @@
+import { Colors as ColorsType } from "../components/base/TMEditorBase";
+import { DeviceType } from "../components";
+import { AppModules, DataColumnDescriptor, DcmtTypeDescriptor, ITopMediaSession, MetadataDescriptor, QueryDescriptor, SearchResultDescriptor } from "@topconsultnpm/sdk-ts";
+import { FileExtensionHandler, FormModes, moduleTypes } from "../ts";
+declare const TABLET_WIDTH = 1024;
+declare const MOBILE_WIDTH = 640;
+declare const calcResponsiveDirection: (deviceType: DeviceType, desktopDir: "horizontal" | "vertical", tabletDir: "horizontal" | "vertical", mobileDir: "horizontal" | "vertical") => "horizontal" | "vertical";
+declare const openApps: (appModule: AppModules, tmSession: ITopMediaSession, appRoutes?: any[]) => Promise<void>;
+export declare const setSDK_GlobalsInfoAsync: (tms: ITopMediaSession | undefined) => Promise<ITopMediaSession | undefined>;
+declare const calcResponsiveSizes: (deviceType: DeviceType | undefined, desktopSize: string, tabletSize: string, mobileSize: string) => string;
+declare const getColor: (color: ColorsType) => string;
+/**
+ * Genera un Universally Unique Identifier (UUID) versione 4.
+ * Simile a Guid.NewGuid() in C#.
+ * @returns {string} Un UUID in formato stringa.
+ */
+export declare const generateUUID: () => string;
+declare const makeID: (length: number) => string;
+export declare const truncateText: (text: string, maxLength: number) => string;
+declare function genUniqueId(): string;
+export declare const captionToDataField: (caption: string | undefined) => string;
+export declare const getDataColumnName: (fromTID: number | undefined, dtColumn: DataColumnDescriptor | undefined) => string;
+/**
+ * Generates unique column keys handling duplicates by adding incremental suffixes.
+ * @param columns Array of DataColumnDescriptor
+ * @param fromTID The TID to use for column name generation
+ * @returns Array of unique column keys
+ */
+export declare const generateUniqueColumnKeys: (columns: DataColumnDescriptor[] | undefined, fromTID: number | undefined) => string[];
+export declare const searchResultDescriptorToSimpleArray: (searchResult: SearchResultDescriptor | undefined) => any[] | undefined;
+export declare const getCompleteMetadataName: (dcmtTypeName: string | undefined, metadataName: string | undefined) => string;
+export declare const getQueryCountAsync: (qd: QueryDescriptor, showSpinner: boolean) => Promise<void>;
+export declare function getTIDByMID(mid: number | undefined, defaultTid?: number): number;
+export declare const getSystemMetadata: (withPerm?: boolean) => MetadataDescriptor[];
+export declare function deepCompare(obj1: any, obj2: any): boolean;
+export declare const extensionHandler: (fileExt: string | undefined) => FileExtensionHandler;
+export declare const downloadBase64File: (base64Data: string, fileName: string) => void;
+export declare const TASK_MORE_INFO_PREFIX_NAME: string;
+export declare const isTaskMoreInfo: (taskName: string | undefined) => boolean | undefined;
+export declare const canNext: (visibleItems: any[], selectedItems: any[]) => boolean;
+export declare const getNext: (visibleItems: any[], selectedItems: any[]) => any;
+export declare const canPrev: (visibleItems: any[], selectedItems: any[]) => boolean;
+export declare const getPrev: (visibleItems: any[], selectedItems: any[]) => any;
+export declare const calcSaveFormTitle: (rootTitle: string | undefined, formMode: FormModes, updateId: number | undefined, pathKeys: string[] | undefined) => string;
+export declare function calcIsModified(formData: any, formDataOrig: any): boolean;
+export { openApps, calcResponsiveDirection, calcResponsiveSizes, getColor, genUniqueId, makeID, MOBILE_WIDTH, TABLET_WIDTH };
+export declare function moduleVersion(module: moduleTypes): string;
+export declare function buildtype(module: moduleTypes): string;
+export declare const highlightText: (text: string, searchValue: string) => JSX.Element;
+export declare const renderHighlightedText: (text: string, searchText: string, isSelected: boolean) => string | (string | import("react/jsx-runtime").JSX.Element)[];
+export declare function versionAndBuildtypeInfo(module: moduleTypes): string;
+export declare const getListMaxItems: (deviceType: DeviceType | undefined) => number;
+export declare const svgToString: (icon: React.ReactElement) => string;
+export declare function stringIsNullOrEmpty(value: string | undefined): boolean;
+export declare function isPositiveNumber(val: unknown): val is number;
+export declare function sleep(ms: number): Promise<void>;
+export declare const dialogConfirmOperation: (title: string, msg: string, operationAsync: () => Promise<void>) => void;
+export declare enum LandingPages {
+    DASHBOARD = "dashboard",
+    SEARCH = "search",
+    ARCHIVE = "archive",
+    WORKING_GROUPS = "workingGroups",
+    WORKFLOW_APPR = "workflowAppr",
+    DOSSIERS = "dossiers",
+    FAVORITES = "favorites",
+    RECENT = "recent",
+    AREA_MANAGER = "areaManager",
+    NOTIFICATIONS = "notifications",
+    ACTIVITIES = "activities"
+}
+export declare function getExceptionMessage(ex: any): string;
+export declare function getContrastColor(inputColor: string): {
+    bgColor: string;
+    textColor: string;
+};
+/** Adds TID to a list of "most recently used" (MRU) TIDs, keeping a maximum of 10 elements  */
+export declare function updateMruTids(currentMruTIDs: number[] | undefined | null, newTid: unknown): number[];
+/** Remove TID to a list of "most recently used" (MRU) TIDs, keeping a maximum of 10 elements  */
+export declare function removeMruTid(currentMruTIDs: number[] | undefined | null, tidToRemove: unknown): number[];
+export declare class AreaValues {
+    aid: number;
+    subFolder: string;
+    fileName: string;
+}
+export declare class AreaHelper {
+    static readonly AreaPathPrefix: string;
+    static readonly AreaFolderNamePrefix: string;
+    static IsAreaPath(areaPath: string | undefined): boolean;
+    static ExtractAreaInfo_1(areaPath: string): AreaValues;
+    static ExtractAreaInfo_2(areaPath: string, extractFileName: boolean): AreaValues;
+}
+export declare const isApprovalWorkflowView: (dtd: DcmtTypeDescriptor) => boolean;