chore: Deprecate Hilla CRUD classes and recommend Flow ones

vaadin · Dec 20, 2024 · 3880eb2 · 3880eb2
1 parent f875edb
commit 3880eb2
Show file tree

Hide file tree

Showing 14 changed files with 64 additions and 0 deletions.
diff --git a/packages/java/endpoint/pom.xml b/packages/java/endpoint/pom.xml
@@ -39,6 +39,10 @@
             <groupId>com.vaadin</groupId>
             <artifactId>flow-server</artifactId>
         </dependency>
+        <dependency>
+            <groupId>com.vaadin</groupId>
+            <artifactId>vaadin-spring</artifactId>
+        </dependency>
         <dependency>
             <groupId>com.vaadin</groupId>
             <artifactId>hilla-engine-core</artifactId>

diff --git a/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/CountService.java b/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/CountService.java
@@ -7,7 +7,10 @@
 /**
  * A browser-callable service that can count the given type of objects with a
  * given filter.
+ *
+ * @deprecated Use {@link com.vaadin.flow.spring.data.CountService} instead
  */
+@Deprecated(forRemoval = true)
 public interface CountService {
 
     /**

diff --git a/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/CrudRepositoryService.java b/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/CrudRepositoryService.java
@@ -12,7 +12,11 @@
 /**
  * A browser-callable service that delegates crud operations to a JPA
  * repository.
+ *
+ * @deprecated Use {@link com.vaadin.flow.spring.data.jpa.CrudRepositoryService}
+ *             instead
  */
+@Deprecated(forRemoval = true)
 @EndpointExposed
 public class CrudRepositoryService<T, ID, R extends CrudRepository<T, ID> & JpaSpecificationExecutor<T>>
         extends ListRepositoryService<T, ID, R> implements CrudService<T, ID> {

diff --git a/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/CrudService.java b/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/CrudService.java
@@ -3,6 +3,9 @@
 /**
  * A browser-callable service that can create, read, update, and delete a given
  * type of object.
+ *
+ * @deprecated Use {@link com.vaadin.flow.spring.data.CrudService} instead
  */
+@Deprecated(forRemoval = true)
 public interface CrudService<T, ID> extends ListService<T>, FormService<T, ID> {
 }
diff --git a/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/GetService.java b/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/GetService.java
@@ -4,7 +4,10 @@
 
 /**
  * A browser-callable service that can fetch the given type of object.
+ *
+ * @deprecated Use {@link com.vaadin.flow.spring.data.GetService} instead
  */
+@Deprecated(forRemoval = true)
 public interface GetService<T, ID> {
 
     /**

diff --git a/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/JpaFilterConverter.java b/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/JpaFilterConverter.java
@@ -12,7 +12,11 @@
  * filter specifications. This class can be used to implement filtering for
  * custom {@link ListService} or {@link CrudService} implementations that use
  * JPA as the data source.
+ *
+ * @deprecated Use {@link com.vaadin.flow.spring.data.jpa.JpaFilterConverter}
+ *             instead
  */
+@Deprecated(forRemoval = true)
 public final class JpaFilterConverter {
 
     private JpaFilterConverter() {

diff --git a/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/ListRepositoryService.java b/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/ListRepositoryService.java
@@ -21,7 +21,11 @@
 /**
  * A browser-callable service that delegates list operations to a JPA
  * repository.
+ *
+ * @deprecated Use {@link com.vaadin.flow.spring.data.jpa.ListRepositoryService}
+ *             instead
  */
+@Deprecated(forRemoval = true)
 @EndpointExposed
 public class ListRepositoryService<T, ID, R extends CrudRepository<T, ID> & JpaSpecificationExecutor<T>>
         implements ListService<T>, GetService<T, ID>, CountService {

diff --git a/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/ListService.java b/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/ListService.java
@@ -10,7 +10,10 @@
 
 /**
  * A browser-callable service that can list the given type of object.
+ *
+ * @deprecated Use {@link com.vaadin.flow.spring.data.ListService} instead
  */
+@Deprecated(forRemoval = true)
 public interface ListService<T> {
     /**
      * Lists objects of the given type using the paging, sorting and filtering

diff --git a/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/filter/AndFilter.java b/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/filter/AndFilter.java
@@ -7,7 +7,10 @@
  * <p>
  * Custom filter implementations need to handle this filter by running all child
  * filters and verifying that all of them pass.
+ *
+ * @deprecated Use {@link com.vaadin.flow.spring.data.filter.AndFilter} instead
  */
+@Deprecated(forRemoval = true)
 public class AndFilter extends Filter {
     private List<Filter> children;
 

diff --git a/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/filter/Filter.java b/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/filter/Filter.java
@@ -15,11 +15,14 @@
  * <li>{@link PropertyStringFilter} - Matches a specific property, or nested
  * property path, against a filter value, using a specific operator.</li>
  * </ul>
+ *
+ * @deprecated Use {@link com.vaadin.flow.spring.data.filter.Filter} instead
  */
 @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY)
 @JsonSubTypes({ @Type(value = OrFilter.class, name = "or"),
         @Type(value = AndFilter.class, name = "and"),
         @Type(value = PropertyStringFilter.class, name = "propertyString") })
+@Deprecated(forRemoval = true)
 public class Filter {
 
 }
diff --git a/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/filter/OrFilter.java b/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/filter/OrFilter.java
@@ -7,7 +7,10 @@
  * <p>
  * Custom filter implementations need to handle this filter by running all child
  * filters and verifying that at least one of them passes.
+ *
+ * @deprecated Use {@link com.vaadin.flow.spring.data.filter.OrFilter} instead
  */
+@Deprecated(forRemoval = true)
 public class OrFilter extends Filter {
 
     private List<Filter> children;

diff --git a/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/filter/PropertyStringFilter.java b/packages/java/endpoint/src/main/java/com/vaadin/hilla/crud/filter/PropertyStringFilter.java
@@ -14,7 +14,12 @@
  * <li>Do the actual comparison using the matcher / operator provided by
  * {@link #getMatcher()}</li>
  * </ul>
+ *
+ * @deprecated Use
+ *             {@link com.vaadin.flow.spring.data.filter.PropertyStringFilter}
+ *             instead
  */
+@Deprecated(forRemoval = true)
 public class PropertyStringFilter extends Filter {
     public enum Matcher {
         EQUALS, CONTAINS, LESS_THAN, GREATER_THAN;

diff --git a/packages/java/tests/csrf-context/pom.xml b/packages/java/tests/csrf-context/pom.xml
@@ -31,6 +31,17 @@
       <artifactId>hilla</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>com.vaadin</groupId>
+      <artifactId>hilla-endpoint</artifactId>
+      <version>${project.version}</version>
+      <exclusions>
+        <exclusion>
+          <groupId>com.vaadin</groupId>
+          <artifactId>vaadin-spring</artifactId>
+        </exclusion>
+      </exclusions>
+    </dependency>
     <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-simple</artifactId>

diff --git a/packages/java/tests/csrf/pom.xml b/packages/java/tests/csrf/pom.xml
@@ -25,6 +25,17 @@
       <artifactId>hilla</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>com.vaadin</groupId>
+      <artifactId>hilla-endpoint</artifactId>
+      <version>${project.version}</version>
+      <exclusions>
+        <exclusion>
+          <groupId>com.vaadin</groupId>
+          <artifactId>vaadin-spring</artifactId>
+        </exclusion>
+      </exclusions>
+    </dependency>
     <dependency>
       <groupId>junit</groupId>
       <artifactId>junit</artifactId>