From 6a2c192d279ef37e236cdf3fc84be4be1b072cd1 Mon Sep 17 00:00:00 2001
From: Jos de Jong <wjosdejong@gmail.com>
Date: Wed, 10 Jul 2024 11:00:00 +0200
Subject: [PATCH 1/2] chore: refactor paste-as-json to invoke a callback
 instead of using `div.cancel()` (see #454)

---
 .../modes/tablemode/TableMode.svelte          | 25 +++--------------
 .../components/modes/treemode/TreeMode.svelte | 28 +++----------------
 .../value/components/EditableValue.svelte     | 22 +++++++++++++--
 src/lib/types.ts                              |  8 ++++--
 4 files changed, 34 insertions(+), 49 deletions(-)

diff --git a/src/lib/components/modes/tablemode/TableMode.svelte b/src/lib/components/modes/tablemode/TableMode.svelte
index 38b5c079..31f0ac84 100644
--- a/src/lib/components/modes/tablemode/TableMode.svelte
+++ b/src/lib/components/modes/tablemode/TableMode.svelte
@@ -77,8 +77,7 @@
     findParentWithNodeName,
     getDataPathFromTarget,
     getWindow,
-    isChildOf,
-    isEditableDivRef
+    isChildOf
   } from '$lib/utils/domUtils.js'
   import { createDebug } from '$lib/utils/debug.js'
   import {
@@ -219,7 +218,7 @@
   let text: string | undefined
   let parseError: ParseError | undefined = undefined
 
-  let pastedJson: PastedJson
+  let pastedJson: PastedJson | undefined
 
   let searchResultDetails: SearchResultDetails | undefined
   let searchResults: SearchResults | undefined
@@ -1096,24 +1095,8 @@
       return
     }
 
-    const { path, contents } = pastedJson
-
-    // exit edit mode
-    const refEditableDiv = refContents?.querySelector('.jse-editable-div') ?? undefined
-    if (isEditableDivRef(refEditableDiv)) {
-      refEditableDiv.cancel()
-    }
-
-    // replace the value with the JSON object/array
-    const operations: JSONPatchDocument = [
-      {
-        op: 'replace',
-        path: compileJSONPointer(path),
-        value: contents
-      }
-    ]
-
-    handlePatch(operations)
+    const { onPasteAsJson } = pastedJson
+    onPasteAsJson()
 
     // TODO: get rid of the setTimeout here
     setTimeout(focus)
diff --git a/src/lib/components/modes/treemode/TreeMode.svelte b/src/lib/components/modes/treemode/TreeMode.svelte
index e9eef6ef..e1cd9923 100644
--- a/src/lib/components/modes/treemode/TreeMode.svelte
+++ b/src/lib/components/modes/treemode/TreeMode.svelte
@@ -79,8 +79,7 @@
     findParentWithNodeName,
     getWindow,
     isChildOf,
-    isChildOfNodeName,
-    isEditableDivRef
+    isChildOfNodeName
   } from '$lib/utils/domUtils.js'
   import {
     convertValue,
@@ -264,7 +263,7 @@
 
   $: debug('selection', selection)
 
-  let pastedJson: PastedJson
+  let pastedJson: PastedJson | undefined
 
   let searchResultDetails: SearchResultDetails | undefined
   let searchResults: SearchResults | undefined
@@ -1770,29 +1769,10 @@
       return
     }
 
-    const { path, contents } = pastedJson
+    const { onPasteAsJson } = pastedJson
     pastedJson = undefined
 
-    // exit edit mode
-    const refEditableDiv = refContents?.querySelector('.jse-editable-div') ?? undefined
-    if (isEditableDivRef(refEditableDiv)) {
-      refEditableDiv.cancel()
-    }
-
-    // replace the value with the JSON object/array
-    const operations: JSONPatchDocument = [
-      {
-        op: 'replace',
-        path: compileJSONPointer(path),
-        value: contents
-      }
-    ]
-
-    handlePatch(operations, (patchedJson, patchedState) => {
-      return {
-        state: expandSmart(patchedJson, patchedState, path)
-      }
-    })
+    onPasteAsJson()
 
     // TODO: get rid of the setTimeout here
     setTimeout(focus)
diff --git a/src/lib/plugins/value/components/EditableValue.svelte b/src/lib/plugins/value/components/EditableValue.svelte
index 285285b9..d1a3be81 100644
--- a/src/lib/plugins/value/components/EditableValue.svelte
+++ b/src/lib/plugins/value/components/EditableValue.svelte
@@ -1,7 +1,7 @@
 <svelte:options immutable={true} />
 
 <script lang="ts">
-  import type { JSONPath } from 'immutable-json-patch'
+  import type { JSONPatchDocument, JSONPath } from 'immutable-json-patch'
   import { compileJSONPointer } from 'immutable-json-patch'
   import { isObjectOrArray, stringConvert } from '$lib/utils/typeUtils.js'
   import { createValueSelection, getFocusPath } from '$lib/logic/selection.js'
@@ -18,6 +18,7 @@
   } from '$lib/types.js'
   import { UpdateSelectionAfterChange } from '$lib/types.js'
   import { isEqual } from 'lodash-es'
+  import { expandSmart } from '$lib/logic/documentState'
 
   export let path: JSONPath
   export let value: unknown
@@ -78,7 +79,24 @@
       if (isObjectOrArray(pastedJson)) {
         onPasteJson({
           path,
-          contents: pastedJson
+          contents: pastedJson,
+          onPasteAsJson: () => {
+            // exit edit mode
+            handleCancelChange()
+
+            // replace the value with the JSON object/array
+            const operations: JSONPatchDocument = [
+              {
+                op: 'replace',
+                path: compileJSONPointer(path),
+                value: pastedJson
+              }
+            ]
+
+            onPatch(operations, (patchedJson, patchedState) => ({
+              state: expandSmart(patchedJson, patchedState, path)
+            }))
+          }
         })
       }
     } catch (err) {
diff --git a/src/lib/types.ts b/src/lib/types.ts
index c8c34caa..f88b704b 100644
--- a/src/lib/types.ts
+++ b/src/lib/types.ts
@@ -383,7 +383,7 @@ export type OnSort = (params: {
 }) => void
 export type OnFind = (findAndReplace: boolean) => void
 export type OnPaste = (pastedText: string) => void
-export type OnPasteJson = (pastedJson: { path: JSONPath; contents: unknown }) => void
+export type OnPasteJson = (pastedJson: PastedJson) => void
 export type OnExpand = (relativePath: JSONPath) => boolean
 export type OnRenderValue = (props: RenderValueProps) => RenderValueComponentDescription[]
 export type OnClassName = (path: JSONPath, value: unknown) => string | undefined
@@ -449,7 +449,11 @@ export interface ValueNormalization {
   unescapeValue: UnescapeValue
 }
 
-export type PastedJson = { contents: unknown; path: JSONPath } | undefined
+export type PastedJson = {
+  path: JSONPath
+  contents: unknown
+  onPasteAsJson: () => void
+}
 
 export interface DragInsideProps {
   json: unknown

From 57d897361cfabd2497381e69fba63fb8634f7fc7 Mon Sep 17 00:00:00 2001
From: Jos de Jong <wjosdejong@gmail.com>
Date: Wed, 10 Jul 2024 11:04:50 +0200
Subject: [PATCH 2/2] chore: cleanup the redundant function `isEditableDivRef`
 and method `.cancel()`

---
 src/lib/components/controls/EditableDiv.svelte |  6 ------
 src/lib/utils/domUtils.ts                      | 14 --------------
 2 files changed, 20 deletions(-)

diff --git a/src/lib/components/controls/EditableDiv.svelte b/src/lib/components/controls/EditableDiv.svelte
index 3d99034d..6f99c3c5 100644
--- a/src/lib/components/controls/EditableDiv.svelte
+++ b/src/lib/components/controls/EditableDiv.svelte
@@ -37,12 +37,6 @@
       // eslint-disable-next-line @typescript-eslint/ban-ts-comment
       // @ts-ignore
       domValue.refresh = handleValueInput
-
-      // The cancel method can be used to cancel editing, without firing a change
-      // when the contents did change in the meantime. It is the same as pressing ESC
-      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-      // @ts-ignore
-      domValue.cancel = handleCancel
     }
   })
 
diff --git a/src/lib/utils/domUtils.ts b/src/lib/utils/domUtils.ts
index c725984a..feeabdbf 100644
--- a/src/lib/utils/domUtils.ts
+++ b/src/lib/utils/domUtils.ts
@@ -405,17 +405,3 @@ export function findNearestElement<T extends Element>({
 
   return undefined
 }
-
-export interface EditableDivElement extends HTMLDivElement {
-  refresh: () => void
-  cancel: () => void
-}
-
-export function isEditableDivRef(element: Element | undefined): element is EditableDivElement {
-  return (
-    !!element &&
-    element.nodeName === 'DIV' &&
-    typeof (element as unknown as Record<string, unknown>).refresh === 'function' &&
-    typeof (element as unknown as Record<string, unknown>).cancel === 'function'
-  )
-}