@zakodium/nmrium-core-plugins-ui 0.1.25 → 0.1.26

package/lib/plugins/spectrum_1d_processings_ui/operators/phase_correction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"phase_correction.d.ts","sourceRoot":"","sources":["../../../../src/plugins/spectrum_1d_processings_ui/operators/phase_correction.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,iBAAiB,yGAO5B,CAAC"}
+{"version":3,"file":"phase_correction.d.ts","sourceRoot":"","sources":["../../../../src/plugins/spectrum_1d_processings_ui/operators/phase_correction.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,iBAAiB,yGAQ5B,CAAC"}

package/lib/plugins/spectrum_1d_processings_ui/operators/phase_correction.js

@@ -1,5 +1,6 @@
 import { defineProcessingOperatorUI } from '@zakodium/nmrium-core';
 import { PhaseCorrectionExpanded } from "./phase_correction_expanded.js";
+import { PhaseCorrectionTool } from "./phase_correction_tool.js";
 export const phaseCorrection1D = defineProcessingOperatorUI({
     id: '@zakodium/nmrium-core-plugins#phaseCorrection1D',
     name: 'Phase correction',
@@ -7,5 +8,6 @@ export const phaseCorrection1D = defineProcessingOperatorUI({
     isLiveEditable: true,
     Expanded: PhaseCorrectionExpanded,
     defaultShouldProcessAll: false,
+    Tool: PhaseCorrectionTool,
 });
 //# sourceMappingURL=phase_correction.js.map

package/lib/plugins/spectrum_1d_processings_ui/operators/phase_correction.js.map

@@ -1 +1 @@
-{"version":3,"file":"phase_correction.js","sourceRoot":"","sources":["../../../../src/plugins/spectrum_1d_processings_ui/operators/phase_correction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,uBAAuB,CAAC;AAEnE,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAiC,CAAC;AAE1E,MAAM,CAAC,MAAM,iBAAiB,GAAG,0BAA0B,CAAC;IAC1D,EAAE,EAAE,iDAAiD;IACrD,IAAI,EAAE,kBAAkB;IACxB,UAAU,EAAE,IAAI;IAChB,cAAc,EAAE,IAAI;IACpB,QAAQ,EAAE,uBAAuB;IACjC,uBAAuB,EAAE,KAAK;CAC/B,CAAC,CAAC"}
+{"version":3,"file":"phase_correction.js","sourceRoot":"","sources":["../../../../src/plugins/spectrum_1d_processings_ui/operators/phase_correction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,uBAAuB,CAAC;AAEnE,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAiC,CAAC;AAC1E,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA6B,CAAC;AAElE,MAAM,CAAC,MAAM,iBAAiB,GAAG,0BAA0B,CAAC;IAC1D,EAAE,EAAE,iDAAiD;IACrD,IAAI,EAAE,kBAAkB;IACxB,UAAU,EAAE,IAAI;IAChB,cAAc,EAAE,IAAI;IACpB,QAAQ,EAAE,uBAAuB;IACjC,uBAAuB,EAAE,KAAK;IAC9B,IAAI,EAAE,mBAAmB;CAC1B,CAAC,CAAC"}

package/lib/plugins/spectrum_1d_processings_ui/operators/phase_correction_tool.d.ts

@@ -0,0 +1,3 @@
+import type { ProcessingOperatorUIToolProps } from '@zakodium/nmrium-core';
+export declare function PhaseCorrectionTool(props: ProcessingOperatorUIToolProps<'@zakodium/nmrium-core-plugins#phaseCorrection1D'>): import("react").JSX.Element | null;
+//# sourceMappingURL=phase_correction_tool.d.ts.map

package/lib/plugins/spectrum_1d_processings_ui/operators/phase_correction_tool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"phase_correction_tool.d.ts","sourceRoot":"","sources":["../../../../src/plugins/spectrum_1d_processings_ui/operators/phase_correction_tool.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,6BAA6B,EAE9B,MAAM,uBAAuB,CAAC;AAmB/B,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,6BAA6B,CAAC,iDAAiD,CAAC,sCAoDxF"}

package/lib/plugins/spectrum_1d_processings_ui/operators/phase_correction_tool.js

@@ -0,0 +1,46 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useHotkeys } from '@blueprintjs/core';
+import { generateID, isSpectrum1DFt } from '@zakodium/nmrium-core';
+import { SvgNmrPhaseCorrection } from 'cheminfo-font';
+import { useMemo } from 'react';
+import { Toolbar, TooltipHelpContent } from 'react-science/ui';
+import { useEventCallback } from 'usehooks-ts';
+function defaultPhaseCorrectionOperation() {
+    return {
+        operatorId: '@zakodium/nmrium-core-plugins#phaseCorrection1D',
+        settings: { mode: 'automatic' },
+        options: undefined,
+        error: undefined,
+        uid: generateID(),
+        enabled: true,
+    };
+}
+export function PhaseCorrectionTool(props) {
+    const { spectrum, liveSpectrum, onTriggerOperation } = props;
+    const firstLiveProcessing = liveSpectrum?.processings?.[0]?.operatorId;
+    const isActive = firstLiveProcessing === '@zakodium/nmrium-core-plugins#phaseCorrection1D';
+    const isVisible = isSpectrum1DFt(spectrum) && spectrum.info.isComplex;
+    const triggerOperation = useEventCallback((event) => {
+        if ('stopImmediatePropagation' in event) {
+            // stopPropagation is not enough because
+            // nmrium keyboard listener is also on document
+            event.stopImmediatePropagation();
+        }
+        onTriggerOperation(defaultPhaseCorrectionOperation());
+    });
+    const hotkeys = useMemo(() => {
+        return [
+            {
+                combo: 'a',
+                label: 'Phase correction',
+                global: true,
+                onKeyDown: triggerOperation,
+            },
+        ];
+    }, [triggerOperation]);
+    useHotkeys(isVisible ? hotkeys : []);
+    if (!isVisible)
+        return null;
+    return (_jsx(Toolbar.Item, { id: "@zakodium/nmrium-core-plugins#phaseCorrection1D", icon: _jsx(SvgNmrPhaseCorrection, {}), tooltip: _jsx(TooltipHelpContent, { title: "Phase correction", shortcuts: ['a'], description: "Correct the spectrum phase manually or automatically. For manual phase correction, define the pivot click, then press the PH0 and PH1 button, and move the mouse horizontally.", link: "https://docs.nmrium.org/help/phase/" }), active: isActive, onClick: triggerOperation }));
+}
+//# sourceMappingURL=phase_correction_tool.js.map

package/lib/plugins/spectrum_1d_processings_ui/operators/phase_correction_tool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"phase_correction_tool.js","sourceRoot":"","sources":["../../../../src/plugins/spectrum_1d_processings_ui/operators/phase_correction_tool.tsx"],"names":[],"mappings":";AACA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAK/C,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAEtD,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAChC,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C,SAAS,+BAA+B;IACtC,OAAO;QACL,UAAU,EAAE,iDAAiD;QAC7D,QAAQ,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE;QAC/B,OAAO,EAAE,SAAS;QAClB,KAAK,EAAE,SAAS;QAChB,GAAG,EAAE,UAAU,EAAE;QACjB,OAAO,EAAE,IAAI;KACd,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,KAAuF;IAEvF,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,kBAAkB,EAAE,GAAG,KAAK,CAAC;IAE7D,MAAM,mBAAmB,GAAG,YAAY,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC;IACvE,MAAM,QAAQ,GACZ,mBAAmB,KAAK,iDAAiD,CAAC;IAE5E,MAAM,SAAS,GAAG,cAAc,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;IAEtE,MAAM,gBAAgB,GAAG,gBAAgB,CACvC,CAAC,KAAiC,EAAE,EAAE;QACpC,IAAI,0BAA0B,IAAI,KAAK,EAAE,CAAC;YACxC,wCAAwC;YACxC,+CAA+C;YAC/C,KAAK,CAAC,wBAAwB,EAAE,CAAC;QACnC,CAAC;QAED,kBAAkB,CAAC,+BAA+B,EAAE,CAAC,CAAC;IACxD,CAAC,CACF,CAAC;IAEF,MAAM,OAAO,GAAG,OAAO,CAAiB,GAAG,EAAE;QAC3C,OAAO;YACL;gBACE,KAAK,EAAE,GAAG;gBACV,KAAK,EAAE,kBAAkB;gBACzB,MAAM,EAAE,IAAI;gBACZ,SAAS,EAAE,gBAAgB;aAC5B;SACF,CAAC;IACJ,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAEvB,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACrC,IAAI,CAAC,SAAS;QAAE,OAAO,IAAI,CAAC;IAE5B,OAAO,CACL,KAAC,OAAO,CAAC,IAAI,IACX,EAAE,EAAC,iDAAiD,EACpD,IAAI,EAAE,KAAC,qBAAqB,KAAG,EAC/B,OAAO,EACL,KAAC,kBAAkB,IACjB,KAAK,EAAC,kBAAkB,EACxB,SAAS,EAAE,CAAC,GAAG,CAAC,EAChB,WAAW,EAAC,gLAAgL,EAC5L,IAAI,EAAC,qCAAqC,GAC1C,EAEJ,MAAM,EAAE,QAAQ,EAChB,OAAO,EAAE,gBAAgB,GACzB,CACH,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zakodium/nmrium-core-plugins-ui",
-  "version": "0.1.25",
+  "version": "0.1.26",
   "license": "CC-BY-NC-SA-4.0",
   "description": "UI related plugins needed for cheminfo/nmrium",
   "keywords": [],
@@ -43,5 +43,5 @@
     "typescript": "~6.0.3",
     "vitest": "^4.1.10"
   },
-  "gitHead": "80667e0063863c55c90ac6cd4f8e3159a2aeaa04"
+  "gitHead": "5862adcdc11eb074b88b8303366f4ef923f36ee0"
 }

package/src/plugins/spectrum_1d_processings_ui/operators/phase_correction.ts

@@ -1,6 +1,7 @@
 import { defineProcessingOperatorUI } from '@zakodium/nmrium-core';
 
 import { PhaseCorrectionExpanded } from './phase_correction_expanded.tsx';
+import { PhaseCorrectionTool } from './phase_correction_tool.tsx';
 
 export const phaseCorrection1D = defineProcessingOperatorUI({
   id: '@zakodium/nmrium-core-plugins#phaseCorrection1D',
@@ -9,4 +10,5 @@ export const phaseCorrection1D = defineProcessingOperatorUI({
   isLiveEditable: true,
   Expanded: PhaseCorrectionExpanded,
   defaultShouldProcessAll: false,
+  Tool: PhaseCorrectionTool,
 });

package/src/plugins/spectrum_1d_processings_ui/operators/phase_correction_tool.tsx

@@ -0,0 +1,78 @@
+import type { HotkeyConfig } from '@blueprintjs/core';
+import { useHotkeys } from '@blueprintjs/core';
+import type {
+  ProcessingOperatorUIToolProps,
+  Spectrum1DProcessingTypeRegistry,
+} from '@zakodium/nmrium-core';
+import { generateID, isSpectrum1DFt } from '@zakodium/nmrium-core';
+import { SvgNmrPhaseCorrection } from 'cheminfo-font';
+import type { MouseEvent } from 'react';
+import { useMemo } from 'react';
+import { Toolbar, TooltipHelpContent } from 'react-science/ui';
+import { useEventCallback } from 'usehooks-ts';
+
+function defaultPhaseCorrectionOperation(): Spectrum1DProcessingTypeRegistry['@zakodium/nmrium-core-plugins#phaseCorrection1D'] {
+  return {
+    operatorId: '@zakodium/nmrium-core-plugins#phaseCorrection1D',
+    settings: { mode: 'automatic' },
+    options: undefined,
+    error: undefined,
+    uid: generateID(),
+    enabled: true,
+  };
+}
+
+export function PhaseCorrectionTool(
+  props: ProcessingOperatorUIToolProps<'@zakodium/nmrium-core-plugins#phaseCorrection1D'>,
+) {
+  const { spectrum, liveSpectrum, onTriggerOperation } = props;
+
+  const firstLiveProcessing = liveSpectrum?.processings?.[0]?.operatorId;
+  const isActive =
+    firstLiveProcessing === '@zakodium/nmrium-core-plugins#phaseCorrection1D';
+
+  const isVisible = isSpectrum1DFt(spectrum) && spectrum.info.isComplex;
+
+  const triggerOperation = useEventCallback(
+    (event: KeyboardEvent | MouseEvent) => {
+      if ('stopImmediatePropagation' in event) {
+        // stopPropagation is not enough because
+        // nmrium keyboard listener is also on document
+        event.stopImmediatePropagation();
+      }
+
+      onTriggerOperation(defaultPhaseCorrectionOperation());
+    },
+  );
+
+  const hotkeys = useMemo<HotkeyConfig[]>(() => {
+    return [
+      {
+        combo: 'a',
+        label: 'Phase correction',
+        global: true,
+        onKeyDown: triggerOperation,
+      },
+    ];
+  }, [triggerOperation]);
+
+  useHotkeys(isVisible ? hotkeys : []);
+  if (!isVisible) return null;
+
+  return (
+    <Toolbar.Item
+      id="@zakodium/nmrium-core-plugins#phaseCorrection1D"
+      icon={<SvgNmrPhaseCorrection />}
+      tooltip={
+        <TooltipHelpContent
+          title="Phase correction"
+          shortcuts={['a']}
+          description="Correct the spectrum phase manually or automatically. For manual phase correction, define the pivot click, then press the PH0 and PH1 button, and move the mouse horizontally."
+          link="https://docs.nmrium.org/help/phase/"
+        />
+      }
+      active={isActive}
+      onClick={triggerOperation}
+    />
+  );
+}