feat: expose modifications (#21)

* feat: expose modifications

* Documentation

* Only expose saved modifications.

+ Add vignette with advise on how to implement custom logic

* documentation

* improve documentation

* Update README

* Update vignette

* change README

---------

Co-authored-by: jschelfhout <jschelfhout@openanalytics.eu>

Author: JasperSch

editbl/DESCRIPTION

@@ -1,7 +1,7 @@
 Package: editbl
 Type: Package
-Version: 1.3.1
-Date: 2025-09-30
+Version: 1.3.2
+Date: 2026-05-20
 Title: 'DT' Extension for CRUD (Create, Read, Update, Delete) Applications in 'shiny'
 Authors@R: c(person("Jasper", "Schelfhout", "", "jasper.schelfhout@openanalytics.eu",
            role = c("aut", "cre")),

editbl/NAMESPACE

@@ -1,5 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
+S3method(e_rows_delete,default)
 S3method(e_rows_insert,default)
 S3method(e_rows_insert,dtplyr_step)
 S3method(e_rows_insert,tbl_dbi)
@@ -14,6 +15,7 @@ export(connectDB)
 export(customButton)
 export(eDT)
 export(eDTOutput)
+export(e_rows_delete)
 export(e_rows_insert)
 export(e_rows_update)
 export(foreignTbl)

editbl/R/eDT.R

@@ -91,6 +91,9 @@ eDTOutput <- function(id,...) {
 #' - result `reactive` modified version of `data` (saved)
 #' - state `reactive` current state of the `data` (unsaved)
 #' - selected `reactive` selected rows of the `data` (unsaved)
+#' - edited `reactive` edited rows (saved)
+#' - inserted `reactive` inserted rows (saved)
+#' - deleted `reactive` deleted rows (saved)
 #' 
 #' @examples 
 #' ## Only run this example in interactive R sessions
@@ -1119,7 +1122,7 @@ eDTServer <- function(
                     # inserts
                     inserted <- effectiveInserted()
                     if(!checkForeignTbls(inserted, foreignTbls())){
-                      stop("You made invalid edits to a row.")
+                      stop("You made invalid inserts.")
                     }
                     inserted <- inserted[,cols,drop=FALSE]
 
@@ -1140,7 +1143,7 @@ eDTServer <- function(
                                 dbplyr::remote_table(result))[base::colnames(deleted)])
                       }
 
-                      result <- rows_delete(
+                      result <- e_rows_delete(
                           x = result,
                           y = deleted,
                           by = keys(),
@@ -1189,7 +1192,12 @@ eDTServer <- function(
 #                      }       
                     }
 
+					# Data to return to user
                     rv$committedData <- result
+					rv$inserted <- inserted
+					rv$edited <- edited
+					rv$deleted <- deleted
+					
 
                     # Set modified and rendered to comitted version
                     # re-read data in case of in_place modification
@@ -1288,7 +1296,10 @@ eDTServer <- function(
         return(list(
                 result = result,
                 state = reactive({castToTemplate(rv$modifiedData[!rv$modifiedData[[deleteCol]],dataVars()], data())}),
-                selected = reactive({castToTemplate(selected()[,dataVars()], data())})
+                selected = reactive({castToTemplate(selected()[,dataVars()], data())}),
+				inserted = reactive({castToTemplate(rv$inserted[,dataVars()], data())}),
+				edited = reactive({castToTemplate(rv$edited[,dataVars()], data())}),
+				deleted = reactive({castToTemplate(rv$deleted[,dataVars()], data())})
             ))
       }
   )

editbl/R/tbl.R

@@ -1,5 +1,43 @@
+#' Delete rows from a tibble
+#' @details Mainly a wrapper around \code{\link[dplyr]{rows_delete}}.
+#' Allows for specific implementations should the behavior differ from what's needed by `editbl`.
+#' Reason for separate method is to avoid conflicts on package loading.
+#' 
+#' @inheritParams dplyr::rows_delete
+#' @inherit dplyr::rows_delete return details
+#' @export
+e_rows_delete <- function(
+		x,
+		y,
+		by = NULL,
+		...,
+		unmatched = c("error", "ignore"),
+		copy = FALSE,
+		in_place = FALSE){
+	UseMethod("e_rows_delete")
+}
+
+#' @inherit e_rows_delete
+#' @export
 #' @importFrom dplyr rows_delete
-NULL
+e_rows_delete.default <- function(
+		x,
+		y,
+		by = NULL,
+		...,
+		unmatched = c("error", "ignore"),
+		copy = FALSE,
+		in_place = FALSE){
+	dplyr::rows_delete(
+			x = x,
+			y = y,
+			by = by,
+			... ,
+			unmatched = unmatched,
+			copy = copy,
+			in_place = in_place)
+}
+
 
 #' Insert rows into a tibble
 #' @details Mainly a wrapper around \code{\link[dplyr]{rows_insert}}.

editbl/README.md

@@ -60,6 +60,7 @@ Advanced examples can be found in the [vignettes](https://github.com/openanalyti
 * Transactional commits (currently for `tbl_dbi` class and non in-place editing)
 * Default values for new rows (UUID's, 'current date', 'inserted by', ...)
 * Possible to set row level security
+* Custom logic/checks before saving ([guidelines](https://github.com/openanalytics/editbl/blob/main/editbl/vignettes/howto_custom_logic.rmd))
 
 ### Constraints and normalized tables
 
@@ -139,7 +140,7 @@ Should you run into problems take a look [here](https://github.com/openanalytics
 It just sends its updates to the backend by matching on the keys of a row. If other users have in the meantime made conflicting adjustments,
 the changes you made might not be executed correctly or errors might be thrown.
 
-## General future goals for this package
+## Roadmap
 
 * Full `dplyr` compatibility so support for different backends is easily facilitated. Now there are 2 methods (`e_rows_update`, `e_rows_insert`) that need to be implemented to support a new backend.
 * Full `DT` compatibility, including all extensions.