spline #1155 Move some consumer related entities to a foxx-api module…

… and generate a TS model

arangodb-foxx-api/pom.xml

@@ -55,17 +55,20 @@
  <argument>--trait-to-type</argument>
  <argument>--option-to-nullable</argument>
  <!-- list of root entities to generate TS definitions -->
- <argument>za.co.absa.spline.producer.service.model.ExecutionPlanPersistentModel</argument>
  <argument>za.co.absa.spline.persistence.model.Progress</argument>
  <argument>za.co.absa.spline.persistence.model.DataSource</argument>
  <argument>za.co.absa.spline.persistence.model.DBVersion</argument>
+ <argument>za.co.absa.spline.producer.service.model.ExecutionPlanPersistentModel</argument>
+ <argument>za.co.absa.spline.consumer.service.model.Frame</argument>
+ <argument>za.co.absa.spline.consumer.service.model.ExecutionPlanInfo</argument>
+ <argument>za.co.absa.spline.consumer.service.model.ExecutionEventInfo</argument>
  </arguments>
  </configuration>
  <dependencies>
  <dependency>
  <groupId>com.github.wajda</groupId>
  <artifactId>scala-ts_${scala.compat.version}</artifactId>
- <version>0.4.1.8</version>
+ <version>0.4.1.9</version>
  </dependency>
  </dependencies>
  </plugin>
@@ -88,4 +91,11 @@
  </plugin>
  </plugins>
  </build>
+
+ <dependencies>
+ <dependency>
+ <groupId>io.swagger</groupId>
+ <artifactId>swagger-annotations</artifactId>
+ </dependency>
+ </dependencies>
 </project>

arangodb-foxx-api/src/main/scala/za/co/absa/spline/consumer/service/model/Frame.scala

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2024 ABSA Group Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package za.co.absa.spline.consumer.service.model
+
+import java.{util => ju}
+
+/**
+ * Represents a frame of items with pagination information.
+ *
+ * @param items items
+ * @param totalCount total count of items
+ * @param offset offset
+ * @tparam T type of items
+ */
+case class Frame[T](
+ items: ju.List[T],
+ totalCount: Long,
+ offset: Int
+)