fix(editor-preview-swagger-ui): fix jump to path feature (#4012)

Refs #3991

Author: char0n

package-lock.json

@@ -59,17 +59,18 @@
     "@emotion/styled": "^11.10.5",
     "@mui/material": "^5.11.15",
     "@primer/octicons-react": "^18.1.0",
-    "@swagger-api/apidom-core": "^0.69.1",
-    "@swagger-api/apidom-ls": "^0.69.1",
-    "@swagger-api/apidom-ns-api-design-systems": "^0.69.1",
-    "@swagger-api/apidom-parser-adapter-api-design-systems-json": "^0.69.1",
-    "@swagger-api/apidom-parser-adapter-api-design-systems-yaml": "^0.69.1",
-    "@swagger-api/apidom-parser-adapter-asyncapi-json-2": "^0.69.1",
-    "@swagger-api/apidom-parser-adapter-asyncapi-yaml-2": "^0.69.1",
-    "@swagger-api/apidom-parser-adapter-openapi-json-3-0": "^0.69.1",
-    "@swagger-api/apidom-parser-adapter-openapi-json-3-1": "^0.69.1",
-    "@swagger-api/apidom-parser-adapter-openapi-yaml-3-0": "^0.69.1",
-    "@swagger-api/apidom-parser-adapter-openapi-yaml-3-1": "^0.69.1",
+    "@swagger-api/apidom-core": "^0.69.2",
+    "@swagger-api/apidom-json-pointer": "^0.69.2",
+    "@swagger-api/apidom-ls": "^0.69.2",
+    "@swagger-api/apidom-ns-api-design-systems": "^0.69.2",
+    "@swagger-api/apidom-parser-adapter-api-design-systems-json": "^0.69.2",
+    "@swagger-api/apidom-parser-adapter-api-design-systems-yaml": "^0.69.2",
+    "@swagger-api/apidom-parser-adapter-asyncapi-json-2": "^0.69.2",
+    "@swagger-api/apidom-parser-adapter-asyncapi-yaml-2": "^0.69.2",
+    "@swagger-api/apidom-parser-adapter-openapi-json-3-0": "^0.69.2",
+    "@swagger-api/apidom-parser-adapter-openapi-json-3-1": "^0.69.2",
+    "@swagger-api/apidom-parser-adapter-openapi-yaml-3-0": "^0.69.2",
+    "@swagger-api/apidom-parser-adapter-openapi-yaml-3-1": "^0.69.2",
     "axios": "^1.3.4",
     "classnames": "^2.3.2",
     "deepmerge": "^4.3.1",

package.json

@@ -24,7 +24,6 @@ import EditorContentOriginPlugin from './plugins/editor-content-origin/index.js'
 import EditorContentTypePlugin from './plugins/editor-content-type/index.js';
 import EditorContentPersistencePlugin from './plugins/editor-content-persistence/index.js';
 import EditorContentFixturesPlugin from './plugins/editor-content-fixtures/index.js';
-import EditorContentJumpFromPathToLinePlugin from './plugins/editor-content-jump-from-path-to-line/index.js';
 import SwaggerUIAdapterPlugin from './plugins/swagger-ui-adapter/index.js';
 
 const SafeRenderPlugin = (system) =>
@@ -70,7 +69,6 @@ SwaggerEditor.plugins = {
   EditorContentType: EditorContentTypePlugin,
   EditorContentPersistence: EditorContentPersistencePlugin,
   EditorContentFixtures: EditorContentFixturesPlugin,
-  EditorContentJumpFromPathToLine: EditorContentJumpFromPathToLinePlugin,
   EditorPreview: EditorPreviewPlugin,
   EditorPreviewSwaggerUI: EditorPreviewSwaggerUIPlugin,
   EditorPreviewAsyncAPI: EditorPreviewAsyncAPIPlugin,
@@ -93,7 +91,6 @@ SwaggerEditor.presets = {
     EditorContentTypePlugin,
     EditorContentPersistencePlugin,
     EditorContentFixturesPlugin,
-    EditorContentJumpFromPathToLinePlugin,
     EditorPreviewPlugin,
     EditorPreviewSwaggerUIPlugin,
     EditorPreviewAsyncAPIPlugin,
@@ -117,7 +114,6 @@ SwaggerEditor.presets = {
     EditorContentTypePlugin,
     EditorContentPersistencePlugin,
     EditorContentFixturesPlugin,
-    EditorContentJumpFromPathToLinePlugin,
     EditorPreviewPlugin,
     EditorPreviewSwaggerUIPlugin,
     EditorPreviewAsyncAPIPlugin,

src/App.jsx

@@ -0,0 +1,49 @@
+import * as monaco from 'monaco-editor';
+
+export const EDITOR_MONACO_LANGUAGE_APIDOM_GET_JSON_POINTER_POSITION_STARTED =
+  'editor_monaco_language_apidom_get_json_pointer_position_started';
+
+export const EDITOR_MONACO_LANGUAGE_APIDOM_GET_JSON_POINTER_POSITION_SUCCESS =
+  'editor_monaco_language_apidom_get_json_pointer_position_success';
+
+export const EDITOR_MONACO_LANGUAGE_APIDOM_GET_JSON_POINTER_POSITION_FAILURE =
+  'editor_monaco_language_apidom_get_json_pointer_position_failure';
+
+export const getJsonPointerPositionStarted = ({ jsonPointer }) => ({
+  type: EDITOR_MONACO_LANGUAGE_APIDOM_GET_JSON_POINTER_POSITION_STARTED,
+  payload: jsonPointer,
+});
+
+export const getJsonPointerPositionSuccess = ({ position, jsonPointer }) => ({
+  type: EDITOR_MONACO_LANGUAGE_APIDOM_GET_JSON_POINTER_POSITION_SUCCESS,
+  payload: position,
+  meta: { jsonPointer },
+});
+
+export const getJsonPointerPositionFailure = ({ error, jsonPointer }) => ({
+  type: EDITOR_MONACO_LANGUAGE_APIDOM_GET_JSON_POINTER_POSITION_FAILURE,
+  error: true,
+  payload: error,
+  meta: { jsonPointer },
+});
+
+export const getJsonPointerPosition = (jsonPointer) => async (system) => {
+  const { editorActions, fn } = system;
+
+  editorActions.getJsonPointerPositionStarted({ jsonPointer });
+
+  try {
+    const [editor] = monaco.editor.getEditors();
+    const model = editor.getModel();
+    const worker = await fn.getApiDOMWorker()(model.uri);
+    const { line, character } = await worker.getJsonPointerPosition(
+      model.uri.toString(),
+      jsonPointer
+    );
+    const position = { lineNumber: line, column: character - 1 };
+
+    return editorActions.getJsonPointerPositionSuccess({ position, jsonPointer });
+  } catch (error) {
+    return editorActions.getJsonPointerPositionFailure({ error, jsonPointer });
+  }
+};

src/plugins/editor-content-jump-from-path-to-line/components/JumpFromPathToLine.jsx

@@ -1,4 +1,10 @@
 import makeAfterLoad from './after-load.js';
+import {
+  getJsonPointerPosition,
+  getJsonPointerPositionStarted,
+  getJsonPointerPositionSuccess,
+  getJsonPointerPositionFailure,
+} from './actions/get-json-pointer-position.js';
 import { getWorker } from './language/monaco.contribution.js';
 
 const EditorMonacoLanguageApiDOMPlugin = (opts = {}) => {
@@ -9,6 +15,16 @@ const EditorMonacoLanguageApiDOMPlugin = (opts = {}) => {
     fn: {
       getApiDOMWorker: getWorker,
     },
+    statePlugins: {
+      editor: {
+        actions: {
+          getJsonPointerPosition,
+          getJsonPointerPositionStarted,
+          getJsonPointerPositionSuccess,
+          getJsonPointerPositionFailure,
+        },
+      },
+    },
   });
 
   return isCalledWithGetSystem ? plugin(opts) : plugin;

src/plugins/editor-content-jump-from-path-to-line/index.js

@@ -5,7 +5,6 @@ import { ModesRegistry } from 'monaco-editor/esm/vs/editor/common/languages/mode
 import * as apidom from './apidom.js';
 import { setupMode } from './apidom-mode.js';
 import createDereferenceActionDescriptor from './actions/dereference.js';
-import jsonPointerPositionActionDescriptor from './actions/json-pointer-position.js';
 
 export { getWorker } from './apidom-mode.js';
 
@@ -102,8 +101,6 @@ const lazyMonacoContribution = ({ createData, system }) => {
           if (!editor.getAction(dereferenceActionDescriptor.id)) {
             disposables.push(editor.addAction(dereferenceActionDescriptor));
           }
-
-          disposables.push(editor.addAction(jsonPointerPositionActionDescriptor));
         })
       );
     })