refactor(home): Change parameters on saveVisit

Result of a feedback on:
https://github.com/backstage/backstage/pull/19645#discussion_r1313865318

Signed-off-by: Renan Mendes Carvalho <aitherios@gmail.com>

plugins/home/api-report.md

@@ -225,7 +225,7 @@ export type VisitFilter = {
 // @public
 export interface VisitsApi {
   listUserVisits(queryParams?: VisitsApiQueryParams): Promise<Visit[]>;
-  saveVisit(pageVisit: Omit<Visit, 'id' | 'hits' | 'timestamp'>): Promise<void>;
+  saveVisit(saveParams: VisitsApiSaveParams): Promise<void>;
 }
 
 // @public
@@ -238,6 +238,11 @@ export type VisitsApiQueryParams = {
 // @public (undocumented)
 export const visitsApiRef: ApiRef<VisitsApi>;
 
+// @public
+export type VisitsApiSaveParams = {
+  visit: Omit<Visit, 'id' | 'hits' | 'timestamp'>;
+};
+
 // @public
 export const WelcomeTitle: ({
   language,

plugins/home/src/api/VisitsApi.ts

@@ -85,6 +85,14 @@ export type VisitsApiQueryParams = {
   filterBy?: VisitFilter[];
 };
 
+/**
+ * @public
+ * This data structure represents the parameters associated with saving visits.
+ */
+export type VisitsApiSaveParams = {
+  visit: Omit<Visit, 'id' | 'hits' | 'timestamp'>;
+};
+
 /**
  * @public
  * Visits API public contract.
@@ -94,7 +102,7 @@ export interface VisitsApi {
    * Persist a new visit.
    * @param pageVisit - a new visit data
    */
-  saveVisit(pageVisit: Omit<Visit, 'id' | 'hits' | 'timestamp'>): Promise<void>;
+  saveVisit(saveParams: VisitsApiSaveParams): Promise<void>;
   /**
    * Get the logged user visits.
    * @param queryParams - optional search query params.