@zakodium/nmr-types 0.5.25 → 0.5.27

package/dist/nmr-types.d.ts

@@ -704,6 +704,49 @@ export declare interface PolynomialOptions {
     degree: number;
 }
 
+/**
+ * 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.
+ *
+ * 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.
+ */
+export declare interface ProcessingInfo1D {
+    /**
+     * If this property is missing, consider the value is 0 (no shifting).
+     * @default 0
+     */
+    shiftX?: number;
+    /**
+     * digitalFilter value if applied.
+     */
+    digitalFilterApplied?: number;
+}
+
+/**
+ * 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.
+ *
+ * The purpose of this interface is to allow easier communication between processing operators,
+ * because some operators depends on other operators.
+ */
+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.
@@ -849,6 +892,16 @@ export declare interface Spectrum1D extends BaseSpectrum {
      * 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;
 }
 
 /**
@@ -895,6 +948,8 @@ export declare interface Spectrum2D extends BaseSpectrum {
      * Can change anytime without migration.
      */
     processings?: Array<Spectrum2DProcessingTypeRegistry[keyof Spectrum2DProcessingTypeRegistry]>;
+    processingInfo: ProcessingInfo2D;
+    originalProcessingInfo: ProcessingInfo2D;
 }
 
 /**
@@ -974,11 +1029,16 @@ export declare interface SpectrumProcessingOperator<SchemaSettings extends ZodTy
      * `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>) => z.output<SchemaOptions>;
+    computeOptions: (spectrum: Spectrum, settings: z.output<SchemaSettings>) => SchemaOptions extends ZodType ? z.output<SchemaOptions> : null;
     /**
      * Returns whether the operation can be applied on given data.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zakodium/nmr-types",
-  "version": "0.5.25",
+  "version": "0.5.27",
   "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": "c52bfe2085c7690604fbcbe2e06ef6de0a66428d"
+  "gitHead": "1cbf517ddf089539fd3f4db5d238a35a8b6c4863"
 }