feat(drafts): implement draft list

kguzek · kguzek · commit a72f2f1cd970 · 2026-02-23T18:29:31.000+01:00
diff --git a/src/app/(private)/review/page.tsx b/src/app/(private)/review/page.tsx
@@ -1,6 +1,5 @@
-import { ErrorMessage } from "@/components/presentation/error-message";
-import { ApplicationError } from "@/config/enums";
+import { ReviewList } from "@/features/review";
 
 export default function ReviewPage() {
-  return <ErrorMessage type={ApplicationError.NotImplemented} />;
+  return <ReviewList />;
 }
diff --git a/src/features/abstract-resource-form/components/arf-controller.tsx b/src/features/abstract-resource-form/components/arf-controller.tsx
@@ -9,6 +9,7 @@ import { toast } from "sonner";
 
 import { ReturnButton } from "@/components/presentation/return-button";
 import { Form } from "@/components/ui/form";
+import { isSolvroAdmin, useAuthentication } from "@/features/authentication";
 import { fetchMutation, useMutationWrapper } from "@/features/backend";
 import type { ModifyResourceResponse } from "@/features/backend/types";
 import { declineNoun } from "@/features/polish";
@@ -64,6 +65,7 @@ export function ArfController<T extends Resource>({
   const schema = RESOURCE_SCHEMAS[resource];
   const router = useRouter();
   const relationContext = useArfRelation();
+  const { user } = useAuthentication();
   const form = useForm<ResourceFormValues<T>>({
     // Maybe try extracting the id from the defaultValues and passing it as an editedResourceId prop
     resolver: zodResolver(schema) as Resolver<ResourceFormValues<T>>,
@@ -109,8 +111,9 @@ export function ArfController<T extends Resource>({
     ResourceFormValues<T>
   >(mutationKey, async (body) => {
     const response = await fetchMutation<ModifyResourceResponse<T>>(endpoint, {
-      body,
+      body: { ...body, createdByUserId: user?.id },
       resource,
+      draft: !isSolvroAdmin(user),
       ...mutationOptions,
     });
     const wasCreated = mutationOptions.method === "POST";
diff --git a/src/features/abstract-resource-list/components/toggle-status-button.tsx b/src/features/abstract-resource-list/components/toggle-status-button.tsx
@@ -1,3 +1,5 @@
+"use client";
+
 import { useQueryClient } from "@tanstack/react-query";
 import { Archive, ArchiveRestore } from "lucide-react";
 import { toast } from "sonner";
diff --git a/src/features/abstract-resource-list/index.ts b/src/features/abstract-resource-list/index.ts
@@ -1 +1,2 @@
 export * from "./components/abstract-resource-list";
+export * from "./components/arl-item";
diff --git a/src/features/authentication/data/permissions.ts b/src/features/authentication/data/permissions.ts
@@ -0,0 +1,3 @@
+export const SOLVRO_ADMINS_ONLY = ["solvro_admin"] as const;
+export const ADMINS_ONLY = ["admin", ...SOLVRO_ADMINS_ONLY] as const;
+export const ANY_AUTHENTICATED_ROLE = ["user", ...ADMINS_ONLY] as const;
diff --git a/src/features/authentication/data/route-permissions.ts b/src/features/authentication/data/route-permissions.ts
@@ -4,40 +4,42 @@ import { Resource } from "@/features/resources";
 import type { RoutableResource } from "@/features/resources/types";
 import type { RecordIntersection } from "@/types/helpers";
 
-const SOLVRO_ADMINS_ONLY = ["solvro_admin"] as const;
-const ADMINS_ONLY = ["admin", ...SOLVRO_ADMINS_ONLY] as const;
-const ANY_AUTHENTICATED_ROLE = ["user", ...ADMINS_ONLY] as const;
+import {
+  ADMINS_ONLY,
+  ANY_AUTHENTICATED_ROLE,
+  SOLVRO_ADMINS_ONLY,
+} from "./permissions";
 
 export const ROUTE_PERMISSIONS = {
   "/": ANY_AUTHENTICATED_ROLE,
-  "/review": SOLVRO_ADMINS_ONLY,
-  [`/${Resource.AboutUs}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.AboutUsLinks}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.AcademicSemesters}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.Aeds}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.Banners}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.BicycleShowers}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.Buildings}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.CalendarEvents}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.Campuses}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.Contributors}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.DaySwaps}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.Departments}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.FoodSpots}`]: ANY_AUTHENTICATED_ROLE,
+  "/review": ADMINS_ONLY,
+  [`/${Resource.AboutUs}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.AboutUsLinks}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.AcademicSemesters}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.Aeds}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.Banners}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.BicycleShowers}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.Buildings}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.CalendarEvents}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.Campuses}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.Contributors}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.DaySwaps}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.Departments}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.FoodSpots}`]: SOLVRO_ADMINS_ONLY,
   [`/${Resource.GuideArticles}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.Holidays}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.Libraries}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.Map}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.Milestones}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.MobileConfig}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.Notifications}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.NotificationTopics}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.PinkBoxes}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.PolinkaStations}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.Roles}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.SksOpeningHours}`]: ANY_AUTHENTICATED_ROLE,
+  [`/${Resource.Holidays}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.Libraries}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.Map}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.Milestones}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.MobileConfig}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.Notifications}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.NotificationTopics}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.PinkBoxes}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.PolinkaStations}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.Roles}`]: SOLVRO_ADMINS_ONLY,
+  [`/${Resource.SksOpeningHours}`]: SOLVRO_ADMINS_ONLY,
   [`/${Resource.StudentOrganizations}`]: ANY_AUTHENTICATED_ROLE,
-  [`/${Resource.Versions}`]: ANY_AUTHENTICATED_ROLE,
+  [`/${Resource.Versions}`]: SOLVRO_ADMINS_ONLY,
 } satisfies RecordIntersection<
   `/${RoutableResource}`,
   Route,
diff --git a/src/features/authentication/index.ts b/src/features/authentication/index.ts
@@ -6,4 +6,5 @@ export * from "./constants";
 export * from "./hooks/use-authentication";
 
 export * from "./utils/get-user-display-name";
+export * from "./utils/is-solvro-admin";
 export * from "./utils/parse-auth-cookie";
diff --git a/src/features/authentication/utils/is-solvro-admin.ts b/src/features/authentication/utils/is-solvro-admin.ts
@@ -0,0 +1,8 @@
+import { SOLVRO_ADMINS_ONLY } from "../data/permissions";
+import type { User } from "../types";
+import { getUserPermissions } from "./get-user-permissions";
+
+export const isSolvroAdmin = (user: User | null): boolean => {
+  const permissions = getUserPermissions(user);
+  return SOLVRO_ADMINS_ONLY.every((role) => permissions.includes(role));
+};
diff --git a/src/features/backend/lib/create-request.ts b/src/features/backend/lib/create-request.ts
@@ -13,6 +13,7 @@ export function createRequest<T extends Resource>(
   {
     accessTokenOverride,
     resource,
+    draft = false,
     body,
     includeRelations = false,
     ...options
@@ -29,7 +30,7 @@ export function createRequest<T extends Resource>(
     };
   }
 
-  const endpointPrefix = getResourceEndpointPrefix(resource);
+  const endpointPrefix = getResourceEndpointPrefix(resource, draft);
   let queryParameters = getRelationQueryParameters(resource, includeRelations);
   if (queryParameters !== "") {
     queryParameters = `${endpoint.includes("?") ? "&" : "?"}${queryParameters}`;
diff --git a/src/features/backend/types/internal.ts b/src/features/backend/types/internal.ts
@@ -10,6 +10,7 @@ interface BaseRequestOptions<T extends Resource>
   headers?: Record<string, string>;
   accessTokenOverride?: string;
   resource?: T;
+  draft?: boolean;
 }
 export interface QueryRequestOptions<T extends Resource>
   extends BaseRequestOptions<T> {
diff --git a/src/features/backend/utils/get-resource-endpoint-prefix.ts b/src/features/backend/utils/get-resource-endpoint-prefix.ts
@@ -1,5 +1,14 @@
 import type { Resource } from "@/features/resources";
 import { getResourceMetadata } from "@/features/resources/node";
 
-export const getResourceEndpointPrefix = (resource: Resource | undefined) =>
-  resource == null ? "" : `${getResourceMetadata(resource).apiPath}/`;
+export const getResourceEndpointPrefix = (
+  resource: Resource | undefined,
+  draft: boolean,
+) => {
+  if (resource == null) {
+    return "";
+  }
+  const metadata = getResourceMetadata(resource);
+  const draftPath = draft ? metadata.apiDraftPath : null;
+  return `${draftPath ?? metadata.apiPath}/`;
+};
diff --git a/src/features/resources/data/resource-metadata.ts b/src/features/resources/data/resource-metadata.ts
@@ -530,6 +530,7 @@ export const RESOURCE_METADATA = {
   },
   [Resource.GuideArticles]: {
     apiPath: "guide_articles",
+    apiDraftPath: "guide_article_drafts",
     orderable: true,
     itemMapper: (item) => ({
       name: item.title,
@@ -836,6 +837,7 @@ export const RESOURCE_METADATA = {
   },
   [Resource.StudentOrganizations]: {
     apiPath: "student_organizations",
+    apiDraftPath: "student_organization_drafts",
     itemMapper: (item) => ({
       name: item.name,
       shortDescription: item.shortDescription,
diff --git a/src/features/resources/index.ts b/src/features/resources/index.ts
@@ -9,6 +9,7 @@ export * from "./components/open-create-sheet-button";
 export * from "./node";
 
 export * from "./utils/is-orderable-resource";
+export * from "./utils/is-resource";
 export * from "./utils/get-field-value";
 export * from "./utils/get-managing-resource-label";
 export * from "./utils/get-resource-array-input-resources";
diff --git a/src/features/resources/types/index.ts b/src/features/resources/types/index.ts
@@ -11,6 +11,7 @@ export type {
   ResourceSchemaKey,
   RoutableResource,
   SubmitFormConfirmationMessage,
+  SpecificResourceMetadata,
 } from "./internal";
 
 export type {
diff --git a/src/features/resources/types/internal.ts b/src/features/resources/types/internal.ts
@@ -96,6 +96,8 @@ export type ResourceMetadata<R extends Resource> = Readonly<{
   pk?: ResourceSchemaKey<R, z.ZodString | z.ZodNumber | AnyZodEnum>;
   /** A mapping of the client-side resources to their paths in the backend API. */
   apiPath: string;
+  /** If the API supports draft models for this resource, the path to be used when creating drafts. */
+  apiDraftPath?: string;
   /** The API version to be used when fetching this resource. Defaults to 1. */
   apiVersion?: number;
   /**
diff --git a/src/features/resources/utils/is-resource.ts b/src/features/resources/utils/is-resource.ts
@@ -0,0 +1,4 @@
+import { Resource } from "../enums";
+
+export const isResource = (resource: string): resource is Resource =>
+  Object.values(Resource).includes(resource as Resource);
diff --git a/src/features/review/api/fetch-drafts.ts b/src/features/review/api/fetch-drafts.ts
@@ -0,0 +1,19 @@
+import "server-only";
+
+import { getAuthStateServer } from "@/features/authentication/server";
+import { fetchQuery } from "@/features/backend";
+
+import type { ResourceDraft } from "../types/internal";
+
+export const fetchDrafts = async () => {
+  const authState = await getAuthStateServer();
+
+  if (authState == null) {
+    return [];
+  }
+
+  const { data } = await fetchQuery<{ data: ResourceDraft[] }>("drafts", {
+    accessTokenOverride: authState.accessToken,
+  });
+  return data;
+};
diff --git a/src/features/review/components/draft-item.tsx b/src/features/review/components/draft-item.tsx
@@ -0,0 +1,30 @@
+import { ArlItem } from "@/features/abstract-resource-list";
+
+import type {
+  DraftableResource,
+  DraftableResourceRelationMap,
+  ResourceDraft,
+} from "../types/internal";
+import { getDraftResource } from "../utils/get-draft-resource";
+
+export function DraftItem<R extends DraftableResource>({
+  draft,
+  relatedResourcesMap,
+}: {
+  draft: ResourceDraft<R>;
+  relatedResourcesMap: DraftableResourceRelationMap;
+}) {
+  const resource = getDraftResource(draft);
+  const relatedResources = relatedResourcesMap[resource];
+  if (relatedResources == null) {
+    throw new Error(`Relations not found for draft resource ${resource}`);
+  }
+
+  return (
+    <ArlItem
+      resource={resource}
+      item={draft.data}
+      relatedResources={relatedResources}
+    />
+  );
+}
diff --git a/src/features/review/components/review-list.tsx b/src/features/review/components/review-list.tsx
@@ -0,0 +1,35 @@
+import { fetchRelatedResources } from "@/features/abstract-resource-form";
+import { typedFromEntries } from "@/utils";
+
+import { fetchDrafts } from "../api/fetch-drafts";
+import type { DraftableResourceRelationMap } from "../types/internal";
+import { getDraftResource } from "../utils/get-draft-resource";
+import { DraftItem } from "./draft-item";
+
+export async function ReviewList() {
+  const data = await fetchDrafts();
+  const drafts = data.map((draft) => ({
+    ...draft,
+    resource: getDraftResource(draft),
+  }));
+  const resources = new Set(drafts.map((draft) => draft.resource));
+  const relatedResourcesMap: DraftableResourceRelationMap = typedFromEntries(
+    await Promise.all(
+      [...resources].map(async (resource) => [
+        resource,
+        await fetchRelatedResources(resource),
+      ]),
+    ),
+  );
+  return (
+    <div>
+      {drafts.map((draft) => (
+        <DraftItem
+          key={`draft-item-${String(draft.data.id)}`}
+          draft={draft}
+          relatedResourcesMap={relatedResourcesMap}
+        />
+      ))}
+    </div>
+  );
+}
diff --git a/src/features/review/data/resource-draft-types.ts b/src/features/review/data/resource-draft-types.ts
@@ -0,0 +1,8 @@
+import { Resource } from "@/features/resources";
+
+import type { DraftableResource } from "../types/internal";
+
+export const RESOURCE_DRAFT_TYPES = {
+  [Resource.GuideArticles]: "article_draft",
+  [Resource.StudentOrganizations]: "organization_draft",
+} as const satisfies Record<DraftableResource, string>;
diff --git a/src/features/review/index.ts b/src/features/review/index.ts
@@ -0,0 +1 @@
+export * from "./components/review-list";
diff --git a/src/features/review/types/internal.ts b/src/features/review/types/internal.ts
@@ -0,0 +1,25 @@
+import type { Resource } from "@/features/resources";
+import type {
+  ResourceDataType,
+  SpecificResourceMetadata,
+} from "@/features/resources/types";
+import type { ResourceRelations } from "@/types/components";
+
+import type { RESOURCE_DRAFT_TYPES } from "../data/resource-draft-types";
+
+export type DraftableResource = {
+  [R in Resource]: SpecificResourceMetadata<R> extends { apiDraftPath: string }
+    ? R
+    : never;
+}[Resource];
+
+export interface ResourceDraft<
+  T extends DraftableResource = DraftableResource,
+> {
+  resourceType: (typeof RESOURCE_DRAFT_TYPES)[T];
+  data: ResourceDataType<T>;
+}
+
+export type DraftableResourceRelationMap = Partial<{
+  [R in DraftableResource]: ResourceRelations<R>;
+}>;
diff --git a/src/features/review/utils/get-draft-resource.ts b/src/features/review/utils/get-draft-resource.ts
@@ -0,0 +1,17 @@
+import { typedEntries } from "@/utils";
+
+import { RESOURCE_DRAFT_TYPES } from "../data/resource-draft-types";
+import type { DraftableResource, ResourceDraft } from "../types/internal";
+
+export const getDraftResource = <R extends DraftableResource>(
+  draft: ResourceDraft<R>,
+): R => {
+  const entry = typedEntries(RESOURCE_DRAFT_TYPES).find(
+    ([_, type]) => type === draft.resourceType,
+  );
+  if (entry == null) {
+    throw new Error(`Unknown draft resource type: ${draft.resourceType}`);
+  }
+  const [resource] = entry;
+  return resource as R;
+};

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`		`-import { ErrorMessage } from "@/components/presentation/error-message";`
`2`		`-import { ApplicationError } from "@/config/enums";`
	`1`	`+import { ReviewList } from "@/features/review";`
`3`	`2`
`4`	`3`	`export default function ReviewPage() {`
`5`		`- return <ErrorMessage type={ApplicationError.NotImplemented} />;`
	`4`	`+ return <ReviewList />;`
`6`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+"use client";`
	`2`	`+`
`1`	`3`	`import { useQueryClient } from "@tanstack/react-query";`
`2`	`4`	`import { Archive, ArchiveRestore } from "lucide-react";`
`3`	`5`	`import { toast } from "sonner";`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`export * from "./components/abstract-resource-list";`
	`2`	`+export * from "./components/arl-item";`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export const SOLVRO_ADMINS_ONLY = ["solvro_admin"] as const;`
	`2`	`+export const ADMINS_ONLY = ["admin", ...SOLVRO_ADMINS_ONLY] as const;`
	`3`	`+export const ANY_AUTHENTICATED_ROLE = ["user", ...ADMINS_ONLY] as const;`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ interface BaseRequestOptions<T extends Resource>`
`10`	`10`	`headers?: Record<string, string>;`
`11`	`11`	`accessTokenOverride?: string;`
`12`	`12`	`resource?: T;`
	`13`	`+ draft?: boolean;`
`13`	`14`	`}`
`14`	`15`	`export interface QueryRequestOptions<T extends Resource>`
`15`	`16`	`extends BaseRequestOptions<T> {`