Merge pull request #17779 from davelopez/24.0_restore_histories_API_b…

…ehaviour_for_keys_query

[24.0] Restore histories API behavior for `keys` query parameter

client/src/api/index.ts

@@ -7,11 +7,19 @@ import { components } from "@/api/schema";
  */
 export type HistorySummary = components["schemas"]["HistorySummary"];
 
+export interface HistorySummaryExtended extends HistorySummary {
+    size: number;
+    contents_active: components["schemas"]["HistoryActiveContentCounts"];
+    user_id: string;
+}
+
 /**
  * Contains additional details about a History.
  */
 export type HistoryDetailed = components["schemas"]["HistoryDetailed"];
 
+export type AnyHistory = HistorySummary | HistorySummaryExtended | HistoryDetailed;
+
 /**
  * Contains minimal information about a HistoryContentItem.
  */
@@ -125,3 +133,46 @@ export function hasDetails(entry: DatasetEntry): entry is DatasetDetails {
  * Contains dataset metadata information.
  */
 export type MetadataFiles = components["schemas"]["MetadataFile"][];
+
+export function isHistorySummary(history: AnyHistory): history is HistorySummary {
+    return !("user_id" in history);
+}
+
+export function isHistorySummaryExtended(history: AnyHistory): history is HistorySummaryExtended {
+    return "contents_active" in history && "user_id" in history;
+}
+
+type QuotaUsageResponse = components["schemas"]["UserQuotaUsage"];
+
+export interface User extends QuotaUsageResponse {
+    id: string;
+    email: string;
+    tags_used: string[];
+    isAnonymous: false;
+    is_admin?: boolean;
+    username?: string;
+}
+
+export interface AnonymousUser {
+    isAnonymous: true;
+    username?: string;
+    is_admin?: false;
+}
+
+export type GenericUser = User | AnonymousUser;
+
+export function isRegisteredUser(user: User | AnonymousUser | null): user is User {
+    return !user?.isAnonymous;
+}
+
+export function userOwnsHistory(user: User | AnonymousUser | null, history: AnyHistory) {
+    return (
+        // Assuming histories without user_id are owned by the current user
+        (isRegisteredUser(user) && !hasOwner(history)) ||
+        (isRegisteredUser(user) && hasOwner(history) && user.id === history.user_id)
+    );
+}
+
+function hasOwner(history: AnyHistory): history is HistorySummaryExtended {
+    return "user_id" in history;
+}