@zakodium/nmr-types 0.5.26 → 0.5.28

package/dist/nmr-types.d.ts

@@ -705,471 +705,529 @@ export declare interface PolynomialOptions {
 }
 
 /**
- * Computed from Spectrum1DProcessingTypeRegistry and Spectrum2DProcessingTypeRegistry keys.
- * Ensures type-safety on operator-registration.
+ * Information produced by processing operators.
+ * Plugins are able to use declaration merging on this interface.
+ * All properties in this interface must be optional so empty object is supported.
  *
- * If the operator is not registered in the type registries. It should not be registerable in the operator registry.
- */
-export declare type ProcessingOperatorId = Exclude<keyof SpectrumProcessingTypeRegistry, number>;
-
-declare type Properties = ListField | SelectField | StringField | NumberField | BooleanField | LabelField;
-
-export declare interface Range extends Omit<NMRRange, 'signals' | 'id'> {
-    id: string;
-    originalFrom?: number;
-    originalTo?: number;
-    absolute: number;
-    signals: Signal1D[];
-    integration: number;
-}
-
-export declare interface Ranges {
-    values: Range[];
-    options: SumOptions;
-}
-
-declare interface SelectField extends Field<any> {
-    type: 'select';
-    choices: any[];
-}
-
-export declare type Shape1DWithFWHM = Omit<NMRShape1D, 'fwhm'> & {
-    fwhm: number;
-};
-
-export declare interface Shapes {
-    exponential?: ShapesFactory<ExponentialOptions>;
-    sineBell?: ShapesFactory<SineBellOptions>;
-    sineSquare?: ShapesFactory<SineSquareOptions>;
-    traf?: ShapesFactory<TrafOptions>;
-    gaussian?: ShapesFactory<GaussianOptions>;
-}
-
-declare interface ShapesFactory<Options> {
-    apply: boolean;
-    options: Options;
-}
-
-export declare interface Shift2DXFilterOptions extends BaseFilter {
-    name: 'shift2DX';
-    value: Shift2DXOptions;
-}
-
-declare interface Shift2DXOptions {
-    shift: number;
-}
-
-export declare interface Shift2DYFilterOptions extends BaseFilter {
-    name: 'shift2DY';
-    value: Shift2DYOptions;
-}
-
-declare interface Shift2DYOptions {
-    shift: number;
-}
-
-export declare interface ShiftXFilterOptions extends BaseFilter {
-    name: 'shiftX';
-    value: ShiftXOptions;
-}
-
-export declare interface ShiftXOptions {
-    shift: number;
-}
-
-export declare interface Signal {
-    id: string;
-    kind?: SignalKind;
-}
-
-export declare interface Signal1D extends Required<Pick<NMRSignal1D, ObjectKeys>>, Omit<NMRSignal1D, ObjectKeys> {
-    originalDelta?: number;
-}
-
-export declare interface Signal2D extends Signal {
-    sign?: number;
-    x: SignalAxis;
-    y: SignalAxis;
-    peaks?: Peak2D[];
-    j?: {
-        pathLength?: number | FromTo;
-    };
-}
-
-declare interface SignalAxis {
-    delta: number;
-    nbAtoms?: number;
-    diaIDs?: string[];
-    originalDelta: number;
-}
-
-export declare type SignalKind = 'unspecified' | 'unknown' | 'signal' | 'residualSolvent' | 'reference' | 'nmrSolvent' | 'impurity' | 'standard' | 'artifact' | 'p1' | 'p2' | 'p3';
-
-export declare interface SignalProcessingFilter extends BaseFilter {
-    name: 'signalProcessing';
-    value: MatrixOptions<FilterOptions>;
-}
-
-export declare interface SineBellOptions {
-    /**
-     * Specifies the starting point of the sine-bell in units of pi radians.
-     * Common values are 0.0 (for a sine window which starts height at 0.0) and
-     * 0.5 (for a cosine window, which starts at height 1.0).
-     * @default 0
-     */
-    offset: number;
-}
-
-export declare type SineSquareOptions = Omit<SineBellOptions, 'exponent'>;
-
-export declare type Spectra = Spectrum[];
-
-export declare type Spectrum = Spectrum1D | Spectrum2D;
-
-export declare interface Spectrum1D extends BaseSpectrum {
-    /**
-     * Contains processed data.
-     *
-     * originalData -> processing pipeline -> data
-     */
-    data: NmrData1D;
-    /**
-     * Original data extracted from the use data files like jcamp / bruker and so-on.
-     */
-    originalData: NmrData1D;
-    peaks: Peaks;
-    display: Display1D;
-    integrals: Integrals;
-    ranges: Ranges;
-    info: Info1D;
-    originalInfo: Info1D;
-    filters: Filter1DEntry[];
-    /**
-     * EXPERIMENTAL type declaration.
-     * Can change anytime without migration.
-     */
-    processings?: Array<Spectrum1DProcessingTypeRegistry[keyof Spectrum1DProcessingTypeRegistry]>;
-}
-
-/**
- * Registry of all the 1d spectrum processing operations.
- * Each plugin adding operator for 1d spectrum processing should register their types here with declaration merging.
- *
- * Use the operatorId as the key, and SpectrumProcessingOperation<Settings, Options> as value.
+ * The purpose of this interface is to allow easier communication between processing operators,
+ * because some operators depends on other operators (ex: fft behavior change if digitalFilter is applied or not).
+ * Other spectrum features can depend on other operator results.
+ * Like peak, range and integrals depends on shiftX.
  *
- * Spectrum1D type definition uses `processings?: Array<Spectrum1DProcessingTypeRegistry[keyof Spectrum1DProcessingTypeRegistry]>;`
+ * Due to immer-js behavior, structuredClone is not usable on immer proxy (draft in reducer).
+ * So, Filters1DManagers / Filters2DManagers uses `{ ...originalProcessingInfo }` to reset.
+ * Try as much as possible to have only one level deep properties in this interface, or provide a way to deep slice this interface in filters managers.
  *
- * @example
- * ```ts
- * declare module '@zakodium/nmr-types' {
- *  interface Spectrum1DProcessingTypeRegistry {
- *    'my-package#myOperator': SpectrumProcessingOperation<MyOperatorSettings, MyOperatorOptions>;
- *  }
- * }
- * ```
+ * nmrium-oss processings managements should not face this issue, because processing does not happen during a reducer action.
+ * And spectrum are sliced before processing.
  */
-export declare interface Spectrum1DProcessingTypeRegistry extends Record<string & {}, // string only break auto complete
-SpectrumProcessingOperation<unknown, unknown>> {
-}
-
-export declare type Spectrum1DSource = Partial<Spectrum1D>;
-
-export declare interface Spectrum2D extends BaseSpectrum {
-    zones: Zones;
+export declare interface ProcessingInfo1D {
     /**
-     * Contains processed data.
-     *
-     * originalData -> processing pipeline -> data
-     */
-    data: NmrData2D;
-    info: Info2D;
-    originalInfo: Info2D;
-    display: Display2D;
-    /**
-     * Original data extracted from the use data files like jcamp / bruker and so-on.
-     */
-    originalData: NmrData2D;
-    filters: Filter2DEntry[];
-    /**
-     * EXPERIMENTAL type declaration.
-     * Can change anytime without migration.
-     */
-    processings?: Array<Spectrum2DProcessingTypeRegistry[keyof Spectrum2DProcessingTypeRegistry]>;
-}
-
-/**
- * Registry of all the 2d spectrum processing operations.
- * Each plugin adding operator for 2d spectrum processing should register their types here with declaration merging.
- *
- * Use the operatorId as the key, and SpectrumProcessingOperation<Settings, Options> as value.
- *
- * Spectrum2D type definition uses `processings?: Array<Spectrum2DProcessingTypeRegistry[keyof Spectrum2DProcessingTypeRegistry]>;`
- *
- * @example
- * ```ts
- * declare module '@zakodium/nmr-types' {
- *  interface Spectrum2DProcessingTypeRegistry {
- *    'my-package#myOperator': SpectrumProcessingOperation<MyOperatorSettings, MyOperatorOptions>;
- *  }
- * }
- * ```
- */
-export declare interface Spectrum2DProcessingTypeRegistry extends Record<string & {}, // string only break auto complete
-SpectrumProcessingOperation<unknown, unknown>> {
-}
-
-export declare type Spectrum2DSource = Partial<Spectrum2D>;
-
-/**
- * A ProcessingOperation is a step in the processing pipeline.
- * A ProcessingOperation can have no options: `ProcessingOperation<undefined>`.
- * ProcessingOperation are stored in NMRiumState spectra in the processing field.
- */
-export declare interface SpectrumProcessingOperation<Settings, Options> {
-    /**
-     * Unique identifier of the operation in the pipeline.
-     * React frontend constraint.
-     */
-    uid: string;
-    /**
-     * `id` of the operator registered in the core processing registry.
-     */
-    operatorId: ProcessingOperatorId;
-    /**
-     * User Parameters for the operation.
-     */
-    settings: Settings;
-    /**
-     * Computed Parameters for the operation.
-     * Computed from settings and the spectrum.
-     *
-     * If `undefined`, options should be computed.
-     */
-    options: Options | undefined;
-    /**
-     * Whether the operation is enabled or not.
-     */
-    enabled: boolean;
-    /**
-     * Error produced by the operation.
-     */
-    error: undefined | string;
-}
-
-export declare interface SpectrumProcessingOperator<SchemaSettings extends ZodType | null, SchemaOptions extends ZodType | null> {
-    /**
-     * Unique identifier (across the core operators registry) for the operation.
-     * Developer-readable, camelCase, package name as prefix.
-     *
-     * @example `@zakodium/nmrium-private-plugins#baselineCorrection`
-     */
-    id: ProcessingOperatorId;
-    /**
-     * Ensure the settings are valid for the operation.
-     * `null` if the operation doesn't need settings.
-     */
-    schemaSettings: SchemaSettings;
-    /**
-     * Ensure the options are valid for the operation.
-     * `null` if the operation doesn't need options, it implies `apply` will always receive `null` as options.
-     */
-    schemaOptions: SchemaOptions;
-    /**
-     * Each operator should define the default settings of operation.
-     * It generally depends on spectrum.
-     */
-    getDefaultSettings: (spectrum: Spectrum) => SchemaSettings extends ZodType ? z.output<SchemaSettings> : null;
-    /**
-     * Function that takes the spectrum in the state of the current pipeline step,
-     * the operation’s settings, and returns options to apply the operation.
-     */
-    computeOptions: (spectrum: Spectrum, settings: z.output<SchemaSettings>) => SchemaOptions extends ZodType ? z.output<SchemaOptions> : null;
-    /**
-     * Returns whether the operation can be applied on given data.
-     *
-     * @param data
-     */
-    isApplicable: (spectrum: Spectrum) => boolean;
-    /**
-     * Function that applies the operation to the spectrum given the options.
-     */
-    apply: (spectrum: Spectrum, options: z.output<SchemaOptions>) => Spectrum;
-    /**
-     * Hints to the caller that the operation will modify the data domain (either x, y, or both),
-     * requiring to reset it in the UI.
-     */
-    domainUpdateRules: DomainUpdateRules;
-}
-
-export declare interface SpectrumProcessingOperatorTypeRegistry extends Record<string & {}, SpectrumProcessingOperator<ZodType | null, ZodType | null>> {
-}
-
-/**
- * Registry of all spectrum processing operations.
- * Use it as a getter from operator id.
- *
- * Dedicated Spectrum1DProcessingTypeRegistry and Spectrum2DProcessingTypeRegistry are needed to fulfill Spectrum1D and Spectrum2D type definition.
- *
- * Plugin developers should not use declaration merging on this interface.
- */
-export declare interface SpectrumProcessingTypeRegistry extends Spectrum1DProcessingTypeRegistry, Spectrum2DProcessingTypeRegistry {
-}
-
-export declare type SpectrumSource = 'prediction' | 'database' | 'unknown';
-
-declare interface StringField extends Field<string> {
-    type: 'string';
-}
-
-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 interface SymmetrizeCosyLikeOptions extends BaseFilter {
-    name: 'symmetrizeCosyLike';
-    value: Record<string, never>;
-}
-
-export declare interface TrafOptions {
-    /**
-     * line broadening value in Hz, a negative value will invert the shape
-     */
-    lineBroadening: number;
-}
-
-export declare interface TrimFilterOptions extends BaseFilter {
-    name: 'trim';
-    value: TrimOptions;
-}
-
-/**
- * Options for trimming a 1D spectrum. All properties are optional and mutually exclusive, the function keep the largest value.
- */
-export declare interface TrimOptions {
-    /**
-     * Percentage (0-100) of points to trim from the left side. If undefined, no percentage-based trimming is applied to the left.
-     * @default undefined
-     */
-    leftPercentage?: number;
-    /**
-     * Percentage (0-100) of points to trim from the right side. If undefined, no percentage-based trimming is applied to the right.
-     * @default undefined
-     */
-    rightPercentage?: number;
-    /**
-     * Value of the leftmost point to keep. If set, all points to the left of this value are trimmed.
-     * @default undefined
-     */
-    leftValue?: number;
-    /**
-     * Value of the rightmost point to keep. If set, all points to the right of this value are trimmed.
-     * @default undefined
-     */
-    rightValue?: number;
-    /**
-     * Number of points to remove from the left side. If set, trims this many points from the left.
+     * If this property is missing, consider the value is 0 (no shifting).
      * @default 0
      */
-    leftNbPoints?: number;
+    shiftX?: number;
     /**
-     * Number of points to remove from the right side. If set, trims this many points from the right.
-     * @default 0
+     * digitalFilter value if applied.
      */
-    rightNbPoints?: number;
+    digitalFilterApplied?: number;
 }
 
-export declare interface WhittakerOptions {
-    algorithm: 'whittaker';
-    /**
-     * Value between [0-1] that indicates how much the initial weight will be updated relative to the absolute
-     * value of an approximation of the standard deviation of the difference between
-     * the baseline and the original signal.
-     * @default 0.2
-     */
-    learningRate?: number;
-    /**
-     * Smoothing parameter. Factor of weights matrix in -> [I + lambda D'D]z = x.
-     * @default 2000
-     */
-    lambda?: number;
-    /**
-     * Maximal number of iterations if the method does not reach the stop criterion.
-     * @default 100
-     */
-    maxIterations?: number;
-    /**
-     * Tolerance for convergence. The process stops if the change in baseline is less than this value.
-     * @default 1e-3
-     */
-    tolerance?: number;
-    /**
-     * Array of x positions (anchors) where the baseline will be estimated.
-     * When provided only the x positions are needed; the corresponding y
-     * values are computed internally using a median window around each x.
-     * @default undefined
-     */
-    anchors?: NumberArray;
-}
-
-export declare interface ZeroFillingDimension1Options extends BaseFilter {
-    name: 'zeroFillingDimension1';
-    value: ZeroFillingOptions;
-}
-
-export declare interface ZeroFillingDimension2Options extends BaseFilter {
-    name: 'zeroFillingDimension2';
-    value: ZeroFillingOptions;
-}
-
-export declare interface ZeroFillingFilterOptions extends BaseFilter {
-    name: 'zeroFilling';
-    value: ZeroFillingOptions;
-}
-
-export declare interface ZeroFillingOptions {
-    nbPoints: number;
-}
-
-export declare interface Zone {
-    id: string;
-    x: ZoneAxis;
-    y: ZoneAxis;
-    signals: Signal2D[];
-    kind?: SignalKind;
-    assignment?: string;
-}
-
-declare interface ZoneAxis extends FromTo {
-    nbAtoms?: number;
-    diaIDs?: string[];
-    originalFrom?: number;
-    originalTo?: number;
-}
-
-export declare interface Zones {
-    values: Zone[];
-    options?: any;
-}
-
-export { }
+/**
+ * Same comment from ProcessingInfo1D apply.
+ * @see {import('./spectrum_1d.ts').ProcessingInfo1D}
+     */
+ export declare interface ProcessingInfo2D {
+     /**
+      * Shift on horizontal axis.
+      * If missing, consider it is 0.
+      */
+     shiftDirect?: number;
+     /**
+      * Shift on vertical axis.
+      * If missing, consider it is 0.
+      */
+     shiftIndirect?: number;
+ }
+
+ /**
+  * Computed from Spectrum1DProcessingTypeRegistry and Spectrum2DProcessingTypeRegistry keys.
+  * Ensures type-safety on operator-registration.
+  *
+  * If the operator is not registered in the type registries. It should not be registerable in the operator registry.
+  */
+ export declare type ProcessingOperatorId = Exclude<keyof SpectrumProcessingTypeRegistry, number>;
+
+ declare type Properties = ListField | SelectField | StringField | NumberField | BooleanField | LabelField;
+
+ export declare interface Range extends Omit<NMRRange, 'signals' | 'id'> {
+     id: string;
+     originalFrom?: number;
+     originalTo?: number;
+     absolute: number;
+     signals: Signal1D[];
+     integration: number;
+ }
+
+ export declare interface Ranges {
+     values: Range[];
+     options: SumOptions;
+ }
+
+ declare interface SelectField extends Field<any> {
+     type: 'select';
+     choices: any[];
+ }
+
+ export declare type Shape1DWithFWHM = Omit<NMRShape1D, 'fwhm'> & {
+     fwhm: number;
+ };
+
+ export declare interface Shapes {
+     exponential?: ShapesFactory<ExponentialOptions>;
+     sineBell?: ShapesFactory<SineBellOptions>;
+     sineSquare?: ShapesFactory<SineSquareOptions>;
+     traf?: ShapesFactory<TrafOptions>;
+     gaussian?: ShapesFactory<GaussianOptions>;
+ }
+
+ declare interface ShapesFactory<Options> {
+     apply: boolean;
+     options: Options;
+ }
+
+ export declare interface Shift2DXFilterOptions extends BaseFilter {
+     name: 'shift2DX';
+     value: Shift2DXOptions;
+ }
+
+ declare interface Shift2DXOptions {
+     shift: number;
+ }
+
+ export declare interface Shift2DYFilterOptions extends BaseFilter {
+     name: 'shift2DY';
+     value: Shift2DYOptions;
+ }
+
+ declare interface Shift2DYOptions {
+     shift: number;
+ }
+
+ export declare interface ShiftXFilterOptions extends BaseFilter {
+     name: 'shiftX';
+     value: ShiftXOptions;
+ }
+
+ export declare interface ShiftXOptions {
+     shift: number;
+ }
+
+ export declare interface Signal {
+     id: string;
+     kind?: SignalKind;
+ }
+
+ export declare interface Signal1D extends Required<Pick<NMRSignal1D, ObjectKeys>>, Omit<NMRSignal1D, ObjectKeys> {
+     originalDelta?: number;
+ }
+
+ export declare interface Signal2D extends Signal {
+     sign?: number;
+     x: SignalAxis;
+     y: SignalAxis;
+     peaks?: Peak2D[];
+     j?: {
+         pathLength?: number | FromTo;
+     };
+ }
+
+ declare interface SignalAxis {
+     delta: number;
+     nbAtoms?: number;
+     diaIDs?: string[];
+     originalDelta: number;
+ }
+
+ export declare type SignalKind = 'unspecified' | 'unknown' | 'signal' | 'residualSolvent' | 'reference' | 'nmrSolvent' | 'impurity' | 'standard' | 'artifact' | 'p1' | 'p2' | 'p3';
+
+ export declare interface SignalProcessingFilter extends BaseFilter {
+     name: 'signalProcessing';
+     value: MatrixOptions<FilterOptions>;
+ }
+
+ export declare interface SineBellOptions {
+     /**
+      * Specifies the starting point of the sine-bell in units of pi radians.
+      * Common values are 0.0 (for a sine window which starts height at 0.0) and
+      * 0.5 (for a cosine window, which starts at height 1.0).
+      * @default 0
+      */
+     offset: number;
+ }
+
+ export declare type SineSquareOptions = Omit<SineBellOptions, 'exponent'>;
+
+ export declare type Spectra = Spectrum[];
+
+ export declare type Spectrum = Spectrum1D | Spectrum2D;
+
+ export declare interface Spectrum1D extends BaseSpectrum {
+     /**
+      * Contains processed data.
+      *
+      * originalData -> processing pipeline -> data
+      */
+     data: NmrData1D;
+     /**
+      * Original data extracted from the use data files like jcamp / bruker and so-on.
+      */
+     originalData: NmrData1D;
+     peaks: Peaks;
+     display: Display1D;
+     integrals: Integrals;
+     ranges: Ranges;
+     info: Info1D;
+     originalInfo: Info1D;
+     filters: Filter1DEntry[];
+     /**
+      * EXPERIMENTAL type declaration.
+      * Can change anytime without migration.
+      */
+     processings?: Array<Spectrum1DProcessingTypeRegistry[keyof Spectrum1DProcessingTypeRegistry]>;
+     /**
+      * State serialization should exclude this property.
+      * Before processing, it should be reset to `originalProcessingInfo`.
+      */
+     processingInfo: ProcessingInfo1D;
+     /**
+      * State serialization should exclude this property.
+      * Before processing, it should be init to empty object.
+      */
+     originalProcessingInfo: ProcessingInfo1D;
+ }
+
+ /**
+  * Registry of all the 1d spectrum processing operations.
+  * Each plugin adding operator for 1d spectrum processing should register their types here with declaration merging.
+  *
+  * Use the operatorId as the key, and SpectrumProcessingOperation<Settings, Options> as value.
+  *
+  * Spectrum1D type definition uses `processings?: Array<Spectrum1DProcessingTypeRegistry[keyof Spectrum1DProcessingTypeRegistry]>;`
+  *
+  * @example
+  * ```ts
+  * declare module '@zakodium/nmr-types' {
+  *  interface Spectrum1DProcessingTypeRegistry {
+  *    'my-package#myOperator': SpectrumProcessingOperation<MyOperatorSettings, MyOperatorOptions>;
+  *  }
+  * }
+  * ```
+  */
+ export declare interface Spectrum1DProcessingTypeRegistry extends Record<string & {}, // string only break auto complete
+ SpectrumProcessingOperation<unknown, unknown>> {
+ }
+
+ export declare type Spectrum1DSource = Partial<Spectrum1D>;
+
+ export declare interface Spectrum2D extends BaseSpectrum {
+     zones: Zones;
+     /**
+      * Contains processed data.
+      *
+      * originalData -> processing pipeline -> data
+      */
+     data: NmrData2D;
+     info: Info2D;
+     originalInfo: Info2D;
+     display: Display2D;
+     /**
+      * Original data extracted from the use data files like jcamp / bruker and so-on.
+      */
+     originalData: NmrData2D;
+     filters: Filter2DEntry[];
+     /**
+      * EXPERIMENTAL type declaration.
+      * Can change anytime without migration.
+      */
+     processings?: Array<Spectrum2DProcessingTypeRegistry[keyof Spectrum2DProcessingTypeRegistry]>;
+     processingInfo: ProcessingInfo2D;
+     originalProcessingInfo: ProcessingInfo2D;
+ }
+
+ /**
+  * Registry of all the 2d spectrum processing operations.
+  * Each plugin adding operator for 2d spectrum processing should register their types here with declaration merging.
+  *
+  * Use the operatorId as the key, and SpectrumProcessingOperation<Settings, Options> as value.
+  *
+  * Spectrum2D type definition uses `processings?: Array<Spectrum2DProcessingTypeRegistry[keyof Spectrum2DProcessingTypeRegistry]>;`
+  *
+  * @example
+  * ```ts
+  * declare module '@zakodium/nmr-types' {
+  *  interface Spectrum2DProcessingTypeRegistry {
+  *    'my-package#myOperator': SpectrumProcessingOperation<MyOperatorSettings, MyOperatorOptions>;
+  *  }
+  * }
+  * ```
+  */
+ export declare interface Spectrum2DProcessingTypeRegistry extends Record<string & {}, // string only break auto complete
+ SpectrumProcessingOperation<unknown, unknown>> {
+ }
+
+ export declare type Spectrum2DSource = Partial<Spectrum2D>;
+
+ /**
+  * A ProcessingOperation is a step in the processing pipeline.
+  * A ProcessingOperation can have no options: `ProcessingOperation<undefined>`.
+  * ProcessingOperation are stored in NMRiumState spectra in the processing field.
+  */
+ export declare interface SpectrumProcessingOperation<Settings, Options> {
+     /**
+      * Unique identifier of the operation in the pipeline.
+      * React frontend constraint.
+      */
+     uid: string;
+     /**
+      * `id` of the operator registered in the core processing registry.
+      */
+     operatorId: ProcessingOperatorId;
+     /**
+      * User Parameters for the operation.
+      */
+     settings: Settings;
+     /**
+      * Computed Parameters for the operation.
+      * Computed from settings and the spectrum.
+      *
+      * If `undefined`, options should be computed.
+      */
+     options: Options | undefined;
+     /**
+      * Whether the operation is enabled or not.
+      */
+     enabled: boolean;
+     /**
+      * Error produced by the operation.
+      */
+     error: undefined | string;
+ }
+
+ export declare interface SpectrumProcessingOperator<SchemaSettings extends ZodType | null, SchemaOptions extends ZodType | null> {
+     /**
+      * Unique identifier (across the core operators registry) for the operation.
+      * Developer-readable, camelCase, package name as prefix.
+      *
+      * @example `@zakodium/nmrium-private-plugins#baselineCorrection`
+      */
+     id: ProcessingOperatorId;
+     /**
+      * Ensure the settings are valid for the operation.
+      * `null` if the operation doesn't need settings.
+      */
+     schemaSettings: SchemaSettings;
+     /**
+      * Ensure the options are valid for the operation.
+      * `null` if the operation doesn't need options, it implies `apply` will always receive `null` as options.
+      */
+     schemaOptions: SchemaOptions;
+     /**
+      * Each operator should define the default settings of operation.
+      * It generally depends on spectrum.
+      */
+     getDefaultSettings: (spectrum: Spectrum) => SchemaSettings extends ZodType ? z.output<SchemaSettings> : null;
+     /**
+      * Function that takes the spectrum in the state of the current pipeline step,
+      * the operation’s settings, and returns options to apply the operation.
+      */
+     computeOptions: (spectrum: Spectrum, settings: z.output<SchemaSettings>) => SchemaOptions extends ZodType ? z.output<SchemaOptions> : null;
+     /**
+      * Returns whether the operation can be applied on given data.
+      *
+      * @param data
+      */
+     isApplicable: (spectrum: Spectrum) => boolean;
+     /**
+      * Function that applies the operation to the spectrum given the options.
+      */
+     apply: (spectrum: Spectrum, options: z.output<SchemaOptions>) => Spectrum;
+     /**
+      * Hints to the caller that the operation will modify the data domain (either x, y, or both),
+      * requiring to reset it in the UI.
+      */
+     domainUpdateRules: DomainUpdateRules;
+ }
+
+ export declare interface SpectrumProcessingOperatorTypeRegistry extends Record<string & {}, SpectrumProcessingOperator<ZodType | null, ZodType | null>> {
+ }
+
+ /**
+  * Registry of all spectrum processing operations.
+  * Use it as a getter from operator id.
+  *
+  * Dedicated Spectrum1DProcessingTypeRegistry and Spectrum2DProcessingTypeRegistry are needed to fulfill Spectrum1D and Spectrum2D type definition.
+  *
+  * Plugin developers should not use declaration merging on this interface.
+  */
+ export declare interface SpectrumProcessingTypeRegistry extends Spectrum1DProcessingTypeRegistry, Spectrum2DProcessingTypeRegistry {
+ }
+
+ export declare type SpectrumSource = 'prediction' | 'database' | 'unknown';
+
+ declare interface StringField extends Field<string> {
+     type: 'string';
+ }
+
+ 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 interface SymmetrizeCosyLikeOptions extends BaseFilter {
+     name: 'symmetrizeCosyLike';
+     value: Record<string, never>;
+ }
+
+ export declare interface TrafOptions {
+     /**
+      * line broadening value in Hz, a negative value will invert the shape
+      */
+     lineBroadening: number;
+ }
+
+ export declare interface TrimFilterOptions extends BaseFilter {
+     name: 'trim';
+     value: TrimOptions;
+ }
+
+ /**
+  * Options for trimming a 1D spectrum. All properties are optional and mutually exclusive, the function keep the largest value.
+  */
+ export declare interface TrimOptions {
+     /**
+      * Percentage (0-100) of points to trim from the left side. If undefined, no percentage-based trimming is applied to the left.
+      * @default undefined
+      */
+     leftPercentage?: number;
+     /**
+      * Percentage (0-100) of points to trim from the right side. If undefined, no percentage-based trimming is applied to the right.
+      * @default undefined
+      */
+     rightPercentage?: number;
+     /**
+      * Value of the leftmost point to keep. If set, all points to the left of this value are trimmed.
+      * @default undefined
+      */
+     leftValue?: number;
+     /**
+      * Value of the rightmost point to keep. If set, all points to the right of this value are trimmed.
+      * @default undefined
+      */
+     rightValue?: number;
+     /**
+      * Number of points to remove from the left side. If set, trims this many points from the left.
+      * @default 0
+      */
+     leftNbPoints?: number;
+     /**
+      * Number of points to remove from the right side. If set, trims this many points from the right.
+      * @default 0
+      */
+     rightNbPoints?: number;
+ }
+
+ export declare interface WhittakerOptions {
+     algorithm: 'whittaker';
+     /**
+      * Value between [0-1] that indicates how much the initial weight will be updated relative to the absolute
+      * value of an approximation of the standard deviation of the difference between
+      * the baseline and the original signal.
+      * @default 0.2
+      */
+     learningRate?: number;
+     /**
+      * Smoothing parameter. Factor of weights matrix in -> [I + lambda D'D]z = x.
+      * @default 2000
+      */
+     lambda?: number;
+     /**
+      * Maximal number of iterations if the method does not reach the stop criterion.
+      * @default 100
+      */
+     maxIterations?: number;
+     /**
+      * Tolerance for convergence. The process stops if the change in baseline is less than this value.
+      * @default 1e-3
+      */
+     tolerance?: number;
+     /**
+      * Array of x positions (anchors) where the baseline will be estimated.
+      * When provided only the x positions are needed; the corresponding y
+      * values are computed internally using a median window around each x.
+      * @default undefined
+      */
+     anchors?: NumberArray;
+ }
+
+ export declare interface ZeroFillingDimension1Options extends BaseFilter {
+     name: 'zeroFillingDimension1';
+     value: ZeroFillingOptions;
+ }
+
+ export declare interface ZeroFillingDimension2Options extends BaseFilter {
+     name: 'zeroFillingDimension2';
+     value: ZeroFillingOptions;
+ }
+
+ export declare interface ZeroFillingFilterOptions extends BaseFilter {
+     name: 'zeroFilling';
+     value: ZeroFillingOptions;
+ }
+
+ export declare interface ZeroFillingOptions {
+     nbPoints: number;
+ }
+
+ export declare interface Zone {
+     id: string;
+     x: ZoneAxis;
+     y: ZoneAxis;
+     signals: Signal2D[];
+     kind?: SignalKind;
+     assignment?: string;
+ }
+
+ declare interface ZoneAxis extends FromTo {
+     nbAtoms?: number;
+     diaIDs?: string[];
+     originalFrom?: number;
+     originalTo?: number;
+ }
+
+ export declare interface Zones {
+     values: Zone[];
+     options?: any;
+ }
+
+ export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zakodium/nmr-types",
-  "version": "0.5.26",
+  "version": "0.5.28",
   "description": "Types related to NMR data processing.",
   "author": "Zakodium Sàrl",
   "license": "CC-BY-NC-SA-4.0",
@@ -39,5 +39,5 @@
   "volta": {
     "extends": "../../../package.json"
   },
-  "gitHead": "be15eb8c8a093cbdcb5eec8d734651350ac1c5c0"
+  "gitHead": "fbf616b9df635e33373aaeb344c86f630fffad69"
 }