@zakodium/nmrium-core 0.0.1

package/dist/nmrium-core.d.ts

@@ -0,0 +1,1146 @@
+import type { CorrelationData } from 'nmr-correlation';
+import type { FifoLoggerOptions } from 'fifo-logger';
+import { FileCollection } from 'filelist-utils';
+import type { FileCollectionItem } from 'filelist-utils';
+import type { Filter1DEntry } from 'nmr-processing';
+import type { Filter1DOptions } from 'nmr-processing';
+import type { Filter2DEntry } from 'nmr-processing';
+import type { Filter2DOptions } from 'nmr-processing';
+import type { Info1D } from 'nmr-processing';
+import type { Info2D } from 'nmr-processing';
+import type { Integrals } from 'nmr-processing';
+import type { Logger } from 'cheminfo-types';
+import type { MatrixOptions } from 'nmr-processing';
+import type { NmrData1D } from 'cheminfo-types';
+import type { NmrData2D } from 'cheminfo-types';
+import type { Peaks } from 'nmr-processing';
+import type { Ranges } from 'nmr-processing';
+import { SerializedNmriumState } from './core_serialize.js';
+import { UUID } from 'crypto';
+import type { WebSource } from 'filelist-utils';
+import type { Zones } from 'nmr-processing';
+
+export declare interface ActiveSpectrum {
+    id: string;
+    index: number;
+    selected: boolean;
+}
+
+export declare interface AdvanceExportSettings extends BaseExportSettings {
+    mode: 'advance';
+    width: number;
+    height: number;
+    unit: Unit;
+}
+
+export declare const ANALYSIS_COLUMN_TYPES: {
+    NORMAL: string;
+    FORMULA: string;
+};
+
+export declare const ANALYSIS_COLUMN_VALUES_KEYS: {
+    RELATIVE: string;
+    ABSOLUTE: string;
+    MIN: string;
+    MAX: string;
+};
+
+export declare type AnalysisColumnsTypes = ExtractValues<typeof ANALYSIS_COLUMN_TYPES>;
+
+export declare type AnalysisColumnsValuesKeys = ExtractValues<typeof ANALYSIS_COLUMN_VALUES_KEYS>;
+
+export declare interface AnalysisOptions {
+    sum: number;
+    code: string | null;
+    columns: SpectraAnalysisColumns;
+    columnIndex: number;
+}
+
+declare interface AnalysisPreferences extends AnalysisOptions {
+    resortSpectra: boolean;
+}
+
+export declare type AutoProcessingFilterEntry = Omit<Filter1DOptions | Filter2DOptions, 'value'>;
+
+declare interface BaseExportSettings {
+    useDefaultSettings: boolean;
+    dpi: number;
+}
+
+declare interface BaseNmriumData {
+    actionType?: string;
+    correlations?: CorrelationData;
+    molecules: StateMolecule[];
+}
+
+export declare interface BaseNucleus1DPreferences<T> {
+    nuclei: Partial<Record<string, T>>;
+}
+
+export declare interface BaseNucleus2DPreferences<T> {
+    nuclei: Partial<Record<string, T>>;
+}
+
+export declare interface BaseNucleusPreferences<T> {
+    nuclei: Partial<Record<string, T>>;
+}
+
+declare interface BaseSpectrum {
+    id: string;
+    sourceSelector?: NmrLoaderSelectors;
+    meta: Metadata;
+    customInfo: any;
+}
+
+declare interface BasicColumnPreferences {
+    visible: boolean;
+    label: string;
+}
+
+export declare interface BasicExportSettings extends BaseExportSettings {
+    mode: 'basic';
+    size: PageSizeName;
+    layout: Layout;
+}
+
+export declare interface BoundingBox {
+    width: number;
+    height: number;
+    x: number;
+    y: number;
+}
+
+export declare interface BrukerLoaderSelector {
+    /**
+     * processing number to select, default the smallest number
+     */
+    processingNumbers?: string;
+    /**
+     * experiment number to select, default all
+     */
+    experimentNumbers?: string;
+    /**
+     * should we take only the first processed data (procno).
+     * @default true
+     */
+    onlyFirstProcessedData?: boolean;
+}
+
+export declare interface Color2D {
+    positiveColor: string;
+    negativeColor: string;
+}
+
+declare interface ColumnPreferences {
+    show: boolean;
+    format: string;
+}
+
+export declare interface ContourItem {
+    contourLevels: [number, number];
+    numberOfLayers: number;
+}
+
+export declare interface ContourOptions {
+    positive: ContourItem;
+    negative: ContourItem;
+}
+
+declare interface ContourOptions_2 {
+    positive: {
+        contourLevels: [number, number];
+        numberOfLayers: number;
+    };
+    negative: {
+        contourLevels: [number, number];
+        numberOfLayers: number;
+    };
+}
+
+export declare type ContoursLevels = Record<string, Level>;
+
+export declare const CURRENT_EXPORT_VERSION = 9;
+
+export declare type CustomWorkspaces = Record<string, InnerWorkspace>;
+
+export declare interface Database {
+    key: string;
+    label: string;
+    url: string;
+    enabled: boolean;
+}
+
+declare interface DatabasePanelPreferences {
+    previewJcamp: boolean;
+    showSmiles: boolean;
+    showSolvent: boolean;
+    showNames: boolean;
+    range: ColumnPreferences;
+    delta: ColumnPreferences;
+    showAssignment: boolean;
+    coupling: ColumnPreferences;
+    showMultiplicity: boolean;
+    color: string;
+    marginBottom: number;
+    allowSaveAsNMRium: boolean;
+    structureSize: {
+        minWidth: number;
+        minHeight: number;
+    };
+}
+
+declare interface Databases {
+    data: Database[];
+    defaultDatabase: string;
+}
+
+export declare type DataSelectionOption = 'ft' | 'fid' | 'both' | 'preferFT' | 'preferFID';
+
+export declare type DeepPartial<T> = {
+    [P in keyof T]?: DeepPartial<T[P]>;
+};
+
+declare interface Display {
+    isVisible: boolean;
+}
+
+export declare interface Display1D extends Display {
+    color: string;
+    isPeaksMarkersVisible: boolean;
+    isRealSpectrumVisible: boolean;
+    isVisibleInDomain: boolean;
+}
+
+export declare interface Display2D extends Color2D, Display {
+    isPositiveVisible: boolean;
+    isNegativeVisible: boolean;
+    contourOptions: ContourOptions_2;
+}
+
+declare interface DisplayPreferences {
+    general?: Partial<NMRiumGeneralPreferences>;
+    panels?: Partial<NMRiumPanelPreferences>;
+    toolBarButtons?: Partial<NMRiumToolBarPreferences>;
+}
+
+declare type Experiment = 'proton' | 'carbon' | 'cosy' | 'hsqc' | 'hmbc';
+
+export declare interface ExportPreferences {
+    png: ExportSettings;
+    svg: ExportSettings;
+    clipboard: ExportSettings;
+}
+
+export declare type ExportSettings = BasicExportSettings | AdvanceExportSettings;
+
+export declare const EXTERNAL_API_KEYS: readonly [{
+    readonly key: "CT";
+    readonly description: "CT from NMR Solutions";
+}];
+
+export declare interface ExternalAPI {
+    key: ExternalAPIKeyType;
+    serverLink: string;
+    APIKey: string;
+}
+
+export declare type ExternalAPIKeyType = (typeof EXTERNAL_API_KEYS)[number]['key'];
+
+declare type ExtractValues<T> = T[keyof T];
+
+declare interface FloatingElement {
+    /**
+     * If the floating  is shown.
+     */
+    visible: boolean;
+    /**
+     * Floating  position.
+     */
+    bounding: BoundingBox;
+}
+
+export declare function formatSpectra(input: any): NmriumData;
+
+export declare interface GeneralLoadersSelector {
+    /**
+     * priories processed or raw data if both exists
+     * @default 'both'
+     */
+    dataSelection?: DataSelectionOption;
+    /**
+     * should we ignore 1D spectra
+     * @default true
+     */
+    keep1D?: boolean;
+    /**
+     * should we ignore 2D spectra
+     * @default true
+     */
+    keep2D?: boolean;
+    /**
+     * should we keep only real part. we will ignore keepFID
+     * @default true
+     */
+    onlyReal?: boolean;
+}
+
+declare interface GeneralPreferences {
+    dimmedSpectraOpacity: number;
+    verticalSplitterPosition: SplitPaneSize;
+    verticalSplitterCloseThreshold: number;
+    spectraRendering: SpectraRendering;
+    loggingLevel: FifoLoggerOptions['level'];
+    popupLoggingLevel: FifoLoggerOptions['level'];
+    invert: boolean;
+    invertScroll: boolean;
+}
+
+export declare const generateID: () => UUID;
+
+/**
+ * It returns an element if the input is an array otherwise it returns the input.
+ * @param data - one list or single value
+ * @param index - index of the desired element, if the index is out of the boundaries it throws an error.
+ * @returns
+ */
+export declare function getOneIfArray<T extends PosibleInput>(data: T | T[], index?: number): T;
+
+declare type IncludeData = 'rawData' | 'dataSource' | 'noData';
+
+declare interface InfoBlock {
+    visible: boolean;
+    fields: InfoBlockField[];
+    position: {
+        x: number;
+        y: number;
+    };
+}
+
+export declare interface InfoBlockField extends JpathTableColumn {
+    format: string;
+}
+
+export declare type InnerWorkspace = WorkspaceMeta & WorkspacePreferences;
+
+declare interface IntegralsNucleusPreferences {
+    showSerialNumber: boolean;
+    absolute: ColumnPreferences;
+    relative: ColumnPreferences;
+    from: ColumnPreferences;
+    to: ColumnPreferences;
+    color: string;
+    strokeWidth: number;
+    showKind: boolean;
+    showDeleteAction: boolean;
+    isSumConstant: boolean;
+}
+
+export declare interface IntegralsViewState {
+    /**
+     * The ratio used to scale the integrals.
+     * @default 1
+     */
+    scaleRatio: number;
+    /**
+     * boolean indicator to hide/show integrals values
+     * @default true
+     */
+    showIntegralsValues: boolean;
+}
+
+export declare type JpathLegendField = Omit<JpathTableColumn, 'label'>;
+
+export declare interface JpathTableColumn extends BasicColumnPreferences {
+    jpath: string[];
+}
+
+export declare type Layout = 'portrait' | 'landscape';
+
+export declare type LegendField = JpathLegendField | PredefinedLegendField;
+
+export declare interface Level {
+    positive: ContourItem;
+    negative: ContourItem;
+}
+
+declare interface LoadersPreferences {
+    general: GeneralLoadersSelector;
+    bruker: BrukerLoaderSelector;
+}
+
+declare type MatrixGeneration = Record<string, MatrixGenerationOptions>;
+
+export declare interface MatrixGenerationOptions {
+    matrixOptions: MatrixOptions;
+    /**
+     * boolean indicator to hide/show box plot
+     * @default false
+     */
+    showBoxPlot: boolean;
+    /**
+     * boolean indicator to hide/show stocsy
+     * @default false
+     */
+    showStocsy: boolean;
+    /**
+     * The ratio used to vertical scale the stocsy and box plot.
+     * @default 1
+     */
+    scaleRatio: number;
+    /**
+     * Chemical shift reference for stocsy
+     * @default null
+     */
+    chemicalShift: number | null;
+}
+
+declare type Metadata = Record<string, any>;
+
+export declare function migrateSettings(input: any): any;
+
+export declare type MoleculesView = Record<string, MoleculeView>;
+
+export declare interface MoleculeView {
+    floating: FloatingElement;
+    /**
+     * Show/Hide atoms numbers on the molecule.
+     */
+    showAtomNumber: boolean;
+}
+
+declare type MultipleSpectraAnalysis = Record<string, MultipleSpectraAnalysisPreferences>;
+
+export declare interface MultipleSpectraAnalysisPreferences {
+    analysisOptions: AnalysisPreferences;
+    legendsFields: LegendField[];
+}
+
+export declare class NMRiumCore {
+    readonly version = 9;
+    private readonly plugins;
+    registerPlugin(plugin: NMRiumPlugin): void;
+    registerPlugins(plugins: NMRiumPlugin[]): void;
+    private migrate;
+    read(input: FileCollection | FileCollectionItem, options?: Partial<ParsingOptions>): ReturnType<typeof read>;
+    readNMRiumObject(nmriumObjectInput: object, options?: ParsingOptions): Promise<Partial<NmriumState>>;
+    readFromWebSource(source: WebSource, options?: ParsingOptions): Promise<Partial<NmriumState>>;
+    serializeNmriumState(nmriumState: NmriumState, options?: SerializeNmriumStateOptions): SerializedNmriumState;
+}
+
+export declare interface NmriumData extends BaseNmriumData {
+    spectra: Spectrum[];
+    source?: WebSource;
+}
+
+export declare interface NmriumDataSource extends BaseNmriumData {
+    spectra: SpectraSource[];
+    source: WebSource;
+}
+
+export declare interface NMRiumGeneralPreferences {
+    hideGeneralSettings: boolean;
+    experimentalFeatures: PanelPreferencesType;
+    hidePanelOnLoad: boolean;
+    hideLogs: boolean;
+    hideWorkspaces: boolean;
+    hideHelp: boolean;
+    hideMaximize: boolean;
+    hidePanelsBar: boolean;
+}
+
+export declare interface NMRiumPanelPreferences {
+    spectraPanel: PanelPreferencesType;
+    informationPanel: PanelPreferencesType;
+    peaksPanel: PanelPreferencesType;
+    integralsPanel: PanelPreferencesType;
+    rangesPanel: PanelPreferencesType;
+    structuresPanel: PanelPreferencesType;
+    processingsPanel: PanelPreferencesType;
+    zonesPanel: PanelPreferencesType;
+    summaryPanel: PanelPreferencesType;
+    multipleSpectraAnalysisPanel: PanelPreferencesType;
+    databasePanel: PanelPreferencesType;
+    predictionPanel: PanelPreferencesType;
+    automaticAssignmentPanel: PanelPreferencesType;
+    matrixGenerationPanel: PanelPreferencesType;
+    simulationPanel: PanelPreferencesType;
+}
+
+export declare interface NMRiumPlugin {
+    id: string;
+    version: number;
+    migrations: NMRiumPluginMigration[];
+    onReadProcess?: NMRiumPluginOnReadProcess;
+}
+
+export declare interface NMRiumPluginMigration {
+    up(state: any): any;
+    minCore: number;
+    maxCore?: number;
+}
+
+export declare interface NMRiumPluginOnReadProcess {
+    /**
+     * Hooks on processFileCollection, in first steps, to extract data from file collection.
+     * Usefully to parse files like nmredata, jcamp, bruker, etc.
+     * @param files
+     * @param options
+     */
+    onFiles?: (files: FileCollection, options?: ParsingOptions) => Promise<NmriumData>;
+    /**
+     * Filter file loader by extension.
+     * Extensions should be in lowercase.
+     */
+    supportedExtensions?: string[];
+    /**
+     * Hooks on processFileCollection, on file iteration.
+     * Each file could be processed by all plugins to load and merge to nmrium data.
+     * use `supportedExtensions` to filter files to be processed by the plugin.
+     * @param file
+     * @param options
+     */
+    onFile?: (file: FileCollectionItem, options?: ParsingOptions) => Promise<NmriumData>;
+    /**
+     * Hooks on processFileCollection, in last steps, after fully load data.
+     * Filter data, apply processing, etc.
+     * This method is synchronous and should mutate the state.
+     * @param files
+     * @param options
+     */
+    onProcessing?: (state: Partial<NmriumState>, options: OnReadProcessOnProcessingOptions) => void;
+}
+
+export declare interface NmriumState {
+    version: number;
+    data: NmriumData;
+    settings: Workspace;
+    view: ViewState;
+    plugins: NmriumStatePlugins;
+}
+
+/**
+ * Plugins should do declaration merging on this interface so `NmriumStatePlugins satisfies Record<string, NmriumStateBasePlugin>`
+ * https://www.typescriptlang.org/docs/handbook/declaration-merging.html
+ *
+ * @example Minimal plugin declaration
+ * ```ts
+ * import type { NmriumStatePlugins, NmriumStateBasePlugin } from 'nmrium-core';
+ *
+ * export interface NmriumStatePlugins {
+ *  'nmrium-core-plugins#Bruker': NmriumStateBasePlugin;
+ * }
+ * ```
+ */
+declare interface NmriumStatePlugins {
+}
+
+export declare interface NMRiumToolBarPreferences {
+    zoom: boolean;
+    zoomOut: boolean;
+    import: boolean;
+    exportAs: boolean;
+    spectraStackAlignments: boolean;
+    spectraCenterAlignments: boolean;
+    realImaginary: boolean;
+    peakPicking: boolean;
+    integral: boolean;
+    zonePicking: boolean;
+    slicing: boolean;
+    rangePicking: boolean;
+    zeroFilling: boolean;
+    zeroFillingDimension1: boolean;
+    zeroFillingDimension2: boolean;
+    apodization: boolean;
+    apodizationDimension1: boolean;
+    apodizationDimension2: boolean;
+    phaseCorrection: boolean;
+    phaseCorrectionTwoDimensions: boolean;
+    baselineCorrection: boolean;
+    fft: boolean;
+    fftDimension1: boolean;
+    fftDimension2: boolean;
+    multipleSpectraAnalysis: boolean;
+    exclusionZones: boolean;
+    autoRangeAndZonePicking: boolean;
+}
+
+/**
+ * Plugins should use Declaration Merging on this interface
+ */
+export declare interface NmrLoaderSelectors {
+    general?: GeneralLoadersSelector;
+    files?: string[];
+}
+
+export declare interface NucleiPreferences {
+    nucleus: string;
+    ppmFormat: string;
+    hzFormat: string;
+    axisFrom?: number;
+    axisTo?: number;
+}
+
+export declare interface OnLoadProcessing {
+    autoProcessing: boolean;
+    filters?: Partial<Record<string, AutoProcessingFilterEntry[]>>;
+}
+
+export declare interface OnReadProcessOnProcessingOptions extends OnLoadProcessing {
+    experimentalFeatures?: boolean;
+}
+
+export declare type PageSizeName = 'Letter' | 'Legal' | 'Tabloid' | 'Executive' | 'Statement' | 'Folio' | 'A3' | 'A4' | 'A5' | 'B4' | 'B5';
+
+export declare interface PanelPreferencesType {
+    display: boolean;
+    visible: boolean;
+    open?: boolean;
+}
+
+export declare interface PanelsPreferences {
+    spectra: BaseNucleusPreferences<SpectraPreferences>;
+    peaks: BaseNucleusPreferences<PeaksNucleusPreferences>;
+    integrals: BaseNucleusPreferences<IntegralsNucleusPreferences>;
+    ranges: BaseNucleusPreferences<RangesNucleusPreferences>;
+    zones: BaseNucleus1DPreferences<Zones1DNucleusPreferences> | BaseNucleus2DPreferences<Zones2DNucleusPreferences>;
+    database: DatabasePanelPreferences;
+    multipleSpectraAnalysis: MultipleSpectraAnalysis;
+    matrixGeneration: MatrixGeneration;
+    prediction: PredictionOptions;
+    structures: BaseNucleusPreferences<StructuresPreferences>;
+}
+
+export declare interface ParsingOptions {
+    name?: string;
+    converter?: Partial<ParsingOptionsConverter>;
+    sourceSelector?: Partial<NmrLoaderSelectors>;
+    /**
+     * if it is true the source object with files will be keeped
+     * @default false
+     */
+    keepSource?: boolean;
+    onLoadProcessing?: OnLoadProcessing;
+    experimentalFeatures?: boolean;
+    logger?: Logger;
+}
+
+/**
+ * Plugins should use Declaration Merging on this interface
+ */
+export declare interface ParsingOptionsConverter {
+}
+
+export declare interface PeaksLabel {
+    marginTop: number;
+}
+
+export declare interface PeaksNucleusPreferences {
+    showSerialNumber: boolean;
+    deltaPPM: ColumnPreferences;
+    deltaHz: ColumnPreferences;
+    peakWidth: ColumnPreferences;
+    intensity: ColumnPreferences;
+    fwhm: ColumnPreferences;
+    mu: ColumnPreferences;
+    gamma: ColumnPreferences;
+    showDeleteAction: boolean;
+    showEditPeakShapeAction: boolean;
+    showKind: boolean;
+    defaultViewOptions?: Partial<PeaksViewState>;
+}
+
+export declare interface PeaksViewState {
+    /**
+     * boolean indicator to hide/show peaks for spectrum
+     * @default true
+     */
+    showPeaks: boolean;
+    /**
+     * boolean indicator to hide/show peaks for shapes spectrum
+     * @default false
+     */
+    showPeaksShapes: boolean;
+    /**
+     * boolean indicator to hide/show peaks sum for spectrum
+     * @default false
+     */
+    showPeaksSum: boolean;
+    /**
+     * displaying mode
+     * @default 'spread'
+     */
+    displayingMode: 'spread' | 'single';
+}
+
+declare type PosibleInput = string | number | boolean;
+
+declare type PredefinedLegend = 'intensity' | 'name';
+
+export declare type PredefinedLegendField = Omit<PredefinedTableColumn<PredefinedLegend>, 'description'>;
+
+export declare type PredefinedSpectraColumn = 'visible' | 'color';
+
+export declare interface PredefinedTableColumn<T> extends BasicColumnPreferences {
+    name: T;
+    description: string;
+    jpath?: string[];
+}
+
+export declare interface PredictionOptions {
+    name: string;
+    frequency: number;
+    '1d': {
+        '1H': {
+            from: number;
+            to: number;
+        };
+        '13C': {
+            from: number;
+            to: number;
+        };
+        nbPoints: number;
+        lineWidth: number;
+    };
+    '2d': {
+        nbPoints: {
+            x: number;
+            y: number;
+        };
+    };
+    autoExtendRange: boolean;
+    spectra: SpectraPredictionOptions;
+    logger: Logger;
+}
+
+export declare interface PrintPageOptions {
+    size: PageSizeName;
+    layout: Layout;
+    margin: number;
+}
+
+declare interface RangesNucleusPreferences {
+    showSerialNumber: boolean;
+    from: ColumnPreferences;
+    to: ColumnPreferences;
+    absolute: ColumnPreferences;
+    relative: ColumnPreferences;
+    deltaPPM: ColumnPreferences;
+    deltaHz: ColumnPreferences;
+    coupling: ColumnPreferences;
+    jGraphTolerance: number;
+    showKind: boolean;
+    showMultiplicity: boolean;
+    showAssignment: boolean;
+    showAssignmentLabel: boolean;
+    showDeleteAction: boolean;
+    showZoomAction: boolean;
+    showEditAction: boolean;
+    defaultViewOptions?: Partial<RangesViewState>;
+    isSumConstant: boolean;
+}
+
+export declare interface RangesViewState {
+    /**
+     * boolean indicator to hide/show peaks for spectrum
+     * @default true
+     */
+    showPeaks: boolean;
+    /**
+     * boolean indicator to hide/show multiplicity tree
+     * @default false
+     */
+    showMultiplicityTrees: boolean;
+    /**
+     * boolean indicator to hide/show J graph for spectrum signals
+     * @default false
+     */
+    showJGraph: boolean;
+    /**
+     * boolean indicator to hide/show integrals for the spectrum ranges
+     * @default true
+     */
+    showIntegrals: boolean;
+    /**
+     * boolean indicator to hide/show integrals values for the spectrum ranges
+     * @default true
+     */
+    showIntegralsValues: boolean;
+    /**
+     * The ratio used to scale the integrals.
+     * @default 1
+     */
+    integralsScaleRatio: number;
+    /**
+     * displaying mode
+     * @default 'spread'
+     */
+    displayingMode: 'spread' | 'single';
+    /**
+     * boolean indicator to hide/show assignments labels on ranges
+     * @default false
+     */
+    showAssignmentsLabels: boolean;
+    /**
+     * boolean indicator to hide/show publication string over spectrum
+     * @default false
+     */
+    showPublicationString: boolean;
+    /**
+     * boolean indicator to hide/show publication string over spectrum
+     * @default false
+     */
+    /**
+     *  publication string box dimension and position
+     */
+    publicationStringBounding: BoundingBox;
+    /**
+     * boolean indicator to hide/show ranges over spectrum
+     * @default false
+     */
+    showRanges: boolean;
+    /**
+     *  ranges box dimension and position
+     */
+    rangesBounding: BoundingBox;
+}
+
+declare function read(_options: ReadOptions): Promise<ReadReturn>;
+
+declare interface ReadOptions {
+    input: FileCollection | FileCollectionItem;
+    migrator: (state: object) => any;
+    plugins: Map<string, NMRiumPlugin>;
+    options?: ParsingOptions;
+}
+
+declare interface ReadReturn {
+    nmriumState: Partial<NmriumState>;
+    containsNmrium: boolean;
+}
+
+declare interface SerializeNmriumStateOptions {
+    includeData?: IncludeData;
+    includeSettings?: boolean;
+    includeView?: boolean;
+}
+
+export declare interface SpectraAnalysisColumn {
+    type: AnalysisColumnsTypes;
+    valueKey: AnalysisColumnsValuesKeys;
+    from: number;
+    to: number;
+    formula?: string;
+    index: number;
+}
+
+export declare type SpectraAnalysisColumns = Record<string, SpectraAnalysisColumn>;
+
+export declare interface SpectraColors {
+    /**
+     * Default colors for 1D spectra.
+     */
+    oneDimension: SpectrumOneDimensionColor[];
+    /**
+     * Default colors for 2D spectra.
+     */
+    twoDimensions: SpectrumTwoDimensionsColor[];
+    /**
+     * Color used to highlight assignments.
+     */
+    highlightColor: string;
+    /**
+     * Color for indicator lines in phase correction, baseline correction, and apodization.
+     */
+    indicatorLineColor: string;
+}
+
+declare type SpectraPredictionOptions = Record<Experiment, boolean>;
+
+export declare interface SpectraPreferences {
+    columns: SpectraTableColumn[];
+}
+
+export declare type SpectraRendering = 'auto' | 'optimizeSpeed' | 'crispEdges' | 'geometricPrecision';
+
+declare type SpectraSource = Spectrum1DSource | Spectrum2DSource;
+
+export declare type SpectraTableColumn = PredefinedTableColumn<PredefinedSpectraColumn> | JpathTableColumn;
+
+export declare type Spectrum = Spectrum1D | Spectrum2D;
+
+export declare interface Spectrum1D extends BaseSpectrum {
+    data: NmrData1D;
+    originalData?: NmrData1D;
+    peaks: Peaks;
+    display: Display1D;
+    integrals: Integrals;
+    ranges: Ranges;
+    info: Info1D;
+    originalInfo?: Info1D;
+    filters: Filter1DEntry[];
+}
+
+export declare type Spectrum1DSource = Partial<Spectrum1D>;
+
+export declare interface Spectrum2D extends BaseSpectrum {
+    zones: Zones;
+    data: NmrData2D;
+    info: Info2D;
+    originalInfo?: Info2D;
+    display: Display2D;
+    originalData?: NmrData2D;
+    filters: Filter2DEntry[];
+}
+
+export declare type Spectrum2DSource = Partial<Spectrum2D>;
+
+declare interface SpectrumColor {
+    jpath: string[];
+    value: string;
+}
+
+export declare interface SpectrumOneDimensionColor extends SpectrumColor {
+    color: string;
+}
+
+export declare interface SpectrumTwoDimensionsColor extends SpectrumColor {
+    positiveColor: string;
+    negativeColor: string;
+}
+
+declare type SplitPaneSize = `${number}%` | `${number}px`;
+
+export declare interface StateMolecule {
+    id?: string;
+    molfile: string;
+    label?: string;
+}
+
+declare interface StructuresPreferences {
+    defaultViewOptions?: Partial<MoleculeView>;
+}
+
+export declare interface SumOptions {
+    /**
+     * @default true
+     */
+    isSumConstant: boolean;
+    /**
+     * If you force the "sum" the mf should not be exists any more otherwise if mf is exists the "sum" must be null or undefined
+     * @default undefined
+     */
+    sum: number | undefined;
+    /**
+     * @default true
+     */
+    sumAuto: boolean;
+    /**
+     * mf will be set automatically for the first time based on the first molecules unless the user change it
+     * example 'C10H20O3'
+     */
+    mf?: string;
+    /**
+     * key of the selected molecule
+     */
+    moleculeId?: string;
+}
+
+export declare type Unit = UnitElement['unit'];
+
+declare type UnitElement = (typeof units)[number];
+
+export declare type UnitName = UnitElement['name'];
+
+export declare const units: readonly [{
+    readonly name: "pixels";
+    readonly unit: "px";
+}, {
+    readonly name: "inches";
+    readonly unit: "in";
+}, {
+    readonly name: "feet";
+    readonly unit: "ft";
+}, {
+    readonly name: "yards";
+    readonly unit: "yd";
+}, {
+    readonly name: "centimeters";
+    readonly unit: "cm";
+}, {
+    readonly name: "millimeters";
+    readonly unit: "mm";
+}, {
+    readonly name: "meters";
+    readonly unit: "m";
+}, {
+    readonly name: "points";
+    readonly unit: "pt";
+}, {
+    readonly name: "picas";
+    readonly unit: "pc";
+}];
+
+export declare type VerticalAlignment = 'bottom' | 'center' | 'stack';
+
+export declare interface ViewState {
+    /**
+     *  Molecules view properties
+     * @default []
+     */
+    molecules: MoleculesView;
+    ranges: Record<string, RangesViewState>;
+    zones: Record<string, ZonesViewState>;
+    integrals: Record<string, IntegralsViewState>;
+    /**
+     * peaks view property
+     * where the key is the id of the spectrum
+     */
+    peaks: Record<string, PeaksViewState>;
+    spectra: {
+        /**
+         * active spectrum id per nucleus
+         * @default {}
+         */
+        activeSpectra: Record<string, ActiveSpectrum[] | null>;
+        selectReferences: Record<string, string>;
+        /**
+         * current select tab (nucleus)
+         * @default null
+         */
+        activeTab: string;
+        /**
+         * show the spectra legend and the intensity
+         * @default false
+         */
+        showLegend: boolean;
+        /**
+         * show the similarity tree
+         * @default false
+         */
+        showSimilarityTree: boolean;
+    };
+    zoom: {
+        levels: ContoursLevels;
+    };
+    /**
+     * options to control spectra vertical alignment
+     * @default  'bottom'
+     */
+    verticalAlign: Partial<Record<string, VerticalAlignment>>;
+    /**
+     * where the key is the molecule id and the value is an array of spectra Ids
+     */
+    predictions: Record<string, string[]>;
+    /**
+     * the current simulated spectrum key
+     */
+    currentSimulatedSpectrumKey: string | null;
+}
+
+export declare interface WheelOptions {
+    shiftKey: boolean;
+    contourOptions: ContourOptions;
+    currentLevel: Level;
+}
+
+export declare type Workspace = WorkspaceMeta & Required<WorkspacePreferences>;
+
+declare interface WorkspaceMeta {
+    label: string;
+    /**
+     * boolean indicator to hide/show Workspace
+     * @default false
+     */
+    visible?: boolean;
+}
+
+export declare interface WorkSpacePanelPreferences {
+    spectra: SpectraPreferences;
+    peaks: PeaksNucleusPreferences;
+    integrals: IntegralsNucleusPreferences;
+    ranges: RangesNucleusPreferences;
+    zones: Zones1DNucleusPreferences | Zones2DNucleusPreferences;
+    database: DatabasePanelPreferences;
+    multipleSpectraAnalysis: MultipleSpectraAnalysis;
+    matrixGeneration: MatrixGeneration;
+    prediction: PredictionOptions;
+    structures: StructuresPreferences;
+}
+
+export declare interface WorkspacePreferences {
+    display?: DisplayPreferences;
+    general?: GeneralPreferences;
+    panels?: Partial<PanelsPreferences>;
+    nuclei?: NucleiPreferences[];
+    databases?: Databases;
+    nmrLoaders?: LoadersPreferences;
+    infoBlock?: InfoBlock;
+    onLoadProcessing?: OnLoadProcessing;
+    spectraColors?: SpectraColors;
+    printPageOptions?: Partial<PrintPageOptions>;
+    externalAPIs?: ExternalAPI[];
+    export?: ExportPreferences;
+    peaksLabel?: PeaksLabel;
+}
+
+/**
+ * custom : workspace which come form the component level <NMRium customWorkspaces = {} />
+ * predefined : workspace which hardcoded in NMRium
+ * user: workspaces which the user create from the general settings
+ * component: workspaces which specified at the level of the component `preferences` property
+ * nmriumFile: workspaces which is come from the the numrium file
+ *
+ * */
+export declare type WorkSpaceSource = 'custom' | 'predefined' | 'user' | 'component' | 'nmriumFile';
+
+export declare interface Zones1DNucleusPreferences {
+    deltaPPM: ColumnPreferences;
+    defaultViewOptions?: Partial<ZonesViewState>;
+}
+
+export declare interface Zones2DNucleusPreferences {
+    showSerialNumber: boolean;
+    showKind: boolean;
+    showDeleteAction: boolean;
+    showZoomAction: boolean;
+    showEditAction: boolean;
+    showAssignment: boolean;
+    /**
+     * boolean indicator to hide/show assignments labels column in zones table
+     * @default false
+     */
+    showAssignmentLabel: boolean;
+    defaultViewOptions?: Partial<ZonesViewState>;
+}
+
+export declare interface ZonesViewState {
+    /**
+     * boolean indicator to hide/show zones
+     * @default false
+     */
+    showZones: boolean;
+    /**
+     * boolean indicator to hide/show signals for spectrum zones
+     * @default false
+     */
+    showSignals: boolean;
+    /**
+     * boolean indicator to hide/show peaks for spectrum zones
+     * @default true
+     */
+    showPeaks: boolean;
+    /**
+     * boolean indicator to hide/show assignments labels on zones
+     * @default false
+     */
+    showAssignmentsLabels: boolean;
+    /**
+     * Coordinates of zones assignment labels, with zone IDs as keys
+     */
+    assignmentsLabelsCoordinates: Record<string, {
+        x: number;
+        y: number;
+    }>;
+}
+
+export { }