Add initial draft of history shared grid config

2026-09-24 16:30:27 +08:00 · 2024-01-11 20:37:08 +03:00
parent ffcce81bd6
commit beccfd3182
1 changed files with 127 additions and 0 deletions
@@ -0,0 +1,127 @@
+import {
+    faExchangeAlt,
+    faEye,
+    faPlus,
+    faShareAlt,
+    faSignature,
+    faTrash,
+    faTrashRestore,
+    faUsers,
+} from "@fortawesome/free-solid-svg-icons";
+import { useEventBus } from "@vueuse/core";
+
+import { deleteHistory, historiesQuery, purgeHistory, undeleteHistory } from "@/api/histories";
+import { updateTags } from "@/api/tags";
+import { useHistoryStore } from "@/stores/historyStore";
+import Filtering, { contains, equals, expandNameTag, toBool, type ValidFilter } from "@/utils/filtering";
+import _l from "@/utils/localization";
+import { errorMessageAsString, rethrowSimple } from "@/utils/simple-error";
+
+import type { ActionArray, FieldArray, GridConfig } from "./types";
+
+const { emit } = useEventBus<string>("grid-router-push");
+
+/**
+ * Local types
+ */
+type HistoryEntry = Record<string, unknown>;
+type SortKeyLiteral = "create_time" | "name" | "update_time" | undefined;
+
+/**
+ * Request and return data from server
+ */
+async function getData(offset: number, limit: number, search: string, sort_by: string, sort_desc: boolean) {
+    const { data, headers } = await historiesQuery({
+        limit,
+        offset,
+        search,
+        sort_by: sort_by as SortKeyLiteral,
+        sort_desc,
+        show_published: false,
+    });
+    const totalMatches = parseInt(headers.get("total_matches") ?? "0");
+    return [data, totalMatches];
+}
+
+/**
+ * Declare columns to be displayed
+ */
+const fields: FieldArray = [
+    {
+        key: "name",
+        title: "Name",
+        type: "operations",
+        operations: [
+            {
+                title: "View",
+                icon: faEye,
+                condition: (data: HistoryEntry) => !data.deleted,
+                handler: (data: HistoryEntry) => {
+                    emit(`/histories/view?id=${data.id}`);
+                },
+            },
+        ],
+    },
+    {
+        key: "id",
+        title: "Size",
+        type: "datasets",
+    },
+    {
+        key: "tags",
+        title: "Tags",
+        type: "tags",
+        handler: async (data: HistoryEntry) => {
+            try {
+                await updateTags(data.id as string, "History", data.tags as Array<string>);
+            } catch (e) {
+                rethrowSimple(e);
+            }
+        },
+    },
+    {
+        key: "create_time",
+        title: "Created",
+        type: "date",
+    },
+    {
+        key: "update_time",
+        title: "Updated",
+        type: "date",
+    },
+    {
+        key: "username",
+        title: "Username",
+        type: "text",
+    },
+];
+
+/**
+ * Declare filter options
+ */
+const validFilters: Record<string, ValidFilter<string | boolean | undefined>> = {
+    title: { placeholder: "name", type: String, handler: contains("name"), menuItem: true },
+    tag: {
+        placeholder: "tag(s)",
+        type: "MultiTags",
+        handler: contains("tag", "tag", expandNameTag),
+        menuItem: true,
+    },
+};
+
+/**
+ * Grid configuration
+ */
+const gridConfig: GridConfig = {
+    id: "histories-shared-grid",
+    fields: fields,
+    filtering: new Filtering(validFilters, undefined, false, false),
+    getData: getData,
+    plural: "Histories",
+    sortBy: "name",
+    sortDesc: true,
+    sortKeys: ["create_time", "name", "update_time", "username"],
+    title: "Shared Histories",
+};
+
+export default gridConfig;