nmr-processing 22.10.0 → 22.10.2

package/dist/nmr-processing.d.ts

@@ -1,4 +1,7 @@
-import type { AnalizeMultipletOptions } from 'multiplet-analysis';
+import type { AnalyseMultipletOptionsNormal } from 'multiplet-analysis';
+import type { AnalyseMultipletOptionsWithDebug } from 'multiplet-analysis';
+import type { AnalyseMultipletResult } from 'multiplet-analysis';
+import type { AnalyseMultipletResultWithDebug } from 'multiplet-analysis';
 import type { Apodization1DFilterOptions } from '@zakodium/nmr-types';
 import type { Apodization1DOptions } from '@zakodium/nmr-types';
 import type { Apodization2D1Options } from '@zakodium/nmr-types';
@@ -2195,7 +2198,7 @@ declare type SignalForMapping = Pick<Signal2D, 'kind'> & {
  * @param signal
  * @param options
  */
-export declare function signalJoinCouplings(signal: NMRSignal1D, options?: SignalJoinCouplingsOptions): NMRSignal1D;
+export declare function signalJoinCouplings<S extends SignalMaybeJcoupling>(signal: S, options?: SignalJoinCouplingsOptions): S;
 
 export declare interface SignalJoinCouplingsOptions {
     /**
@@ -2219,6 +2222,8 @@ export declare const signalKindLabelMapping: Readonly<Record<SignalKind, string>
 
 export declare const signalKindsToInclude: ReadonlySet<SignalKind>;
 
+declare type SignalMaybeJcoupling = Pick<NMRSignal1D, 'js'>;
+
 /**
  * Return
  * @param signal
@@ -2646,22 +2651,31 @@ export declare function xForwardLinearPrediction(data: DoubleArray, options: For
     predicted: Float64Array<ArrayBuffer>;
 };
 
-export declare interface XreimMultipletAnalysis {
-    analyzer?: AnalizeMultipletOptions;
-    autoPhase?: boolean;
-}
-
 /**
  * Determination of J couplings by recursive deconvolution in the frequency domain,
- * it use the method published by Damien Jeannerat and Geoffrey Bodenhausen @link{https://doi.org/10.1006/jmre.1999.1845}
- * @param data
+ * it uses the method published by Damien Jeannerat and Geoffrey Bodenhausen @link{https://doi.org/10.1006/jmre.1999.1845}
+ * @param data - Imaginary data is optional for auto phase correction of the region before the analysis.
  * @param options
  */
-export declare function xreimMultipletAnalysis(
-/**
- * Imaginary data is optional for auto phase correction of the region before the analysis.
- */
-data: DataXReOptionalIm, options?: XreimMultipletAnalysis): any;
+export declare function xreimMultipletAnalysis(data: DataXReOptionalIm, options: XreimMultipletAnalysisOptionsNormal): AnalyseMultipletResult;
+
+export declare function xreimMultipletAnalysis(data: DataXReOptionalIm, options: XreimMultipletAnalysisOptionsWithDebug): AnalyseMultipletResultWithDebug;
+
+export declare interface XreimMultipletAnalysisOptionsBase {
+    autoPhase?: boolean;
+}
+
+export declare interface XreimMultipletAnalysisOptionsNormal extends XreimMultipletAnalysisOptionsBase {
+    analyzer: AnalyseMultipletOptionsNormal;
+}
+
+export declare interface XreimMultipletAnalysisOptionsWithDebug extends XreimMultipletAnalysisOptionsBase {
+    analyzer: AnalyseMultipletOptionsWithDebug;
+}
+
+export declare type XreimMultipletAnalysisResult = AnalyseMultipletResult;
+
+export declare type XreimMultipletAnalysisResultWithDebug = AnalyseMultipletResultWithDebug;
 
 /**
  * Trims the input arrays in the object by removing points from the low and high according to the provided options.