draft changed to status

client/setupTests.mjs

@@ -9,10 +9,10 @@ global.fetch = whatwgFetch;
 export const resourceStub = (overrides = {}) => ({
 	accession: new Date(),
 	description: null,
-	draft: false,
+	status: "published",
 	id: randomUUID(),
-	publication: null,
-	publisher: null,
+	statusChangedDate: null,
+	statusChangedBy: null,
 	source: randomUUID(),
 	title: "",
 	topic: null,

client/src/pages/Drafts/Drafts.test.jsx

@@ -41,7 +41,7 @@ describe("Drafts", () => {
 			}),
 			http.patch("/api/resources/:id", ({ request: req }) => {
 				patchRequest = req;
-				return HttpResponse.json({ ...resource, draft: false });
+				return HttpResponse.json({ ...resource, status: "published" });
 			})
 		);
 		render(<Drafts />);

client/src/pages/Drafts/index.jsx

@@ -13,7 +13,7 @@ export default function Drafts() {
 
 	const publish = useCallback(
 		async (id) => {
-			await resourceService.publish(id);
+			await resourceService.action(id, "published");
 			await refreshDrafts();
 		},
 		[refreshDrafts, resourceService]
@@ -22,7 +22,7 @@ export default function Drafts() {
 	const reject = useCallback(
 		async (id) => {
 			if (window.confirm("Do you really want to reject?")) {
-				await resourceService.reject(id);
+				await resourceService.action(id, "rejected");
 				await refreshDrafts();
 			}
 		},

client/src/services/resourceService.js

@@ -7,7 +7,7 @@ export default class ResourceService {
 
 	async getDrafts() {
 		const res = await this.fetch(
-			`${ResourceService.ENDPOINT}?${new URLSearchParams({ draft: true })}`
+			`${ResourceService.ENDPOINT}?${new URLSearchParams({ status: "drafted" })}`
 		);
 		if (res.ok) {
 			const { resources } = await res.json();
@@ -30,9 +30,9 @@ export default class ResourceService {
 		}
 	}
 
-	async publish(id) {
+	async action(id, status) {
 		const res = await this.fetch(`${ResourceService.ENDPOINT}/${id}`, {
-			body: JSON.stringify({ draft: false }),
+			body: JSON.stringify({ status }),
 			headers: { "Content-Type": "application/json" },
 			method: "PATCH",
 		});
@@ -41,17 +41,6 @@ export default class ResourceService {
 		}
 	}
 
-	async reject(id) {
-		const res = await this.fetch(`${ResourceService.ENDPOINT}/${id}`, {
-			body: JSON.stringify({ draft: false }),
-			headers: { "Content-Type": "application/json" },
-			method: "DELETE",
-		});
-		if (res.ok) {
-			return this._revive(await res.json());
-		}
-	}
-
 	async suggest(resource) {
 		const res = await this.fetch(ResourceService.ENDPOINT, {
 			body: JSON.stringify(resource),
@@ -68,11 +57,11 @@ export default class ResourceService {
 		}
 	}
 
-	_revive({ accession, publication, ...resource }) {
+	_revive({ accession, statusChangedDate, ...resource }) {
 		return {
 			...resource,
 			accession: accession && new Date(accession),
-			publication: publication && new Date(publication),
+			statusChangedDate: statusChangedDate && new Date(statusChangedDate),
 		};
 	}
 }

client/src/services/resourceService.test.js

@@ -17,12 +17,12 @@ describe("ResourceService", () => {
 				})
 			);
 			await service.getDrafts();
-			expect(new URL(request.url).searchParams.get("draft")).toBe("true");
+			expect(new URL(request.url).searchParams.get("status")).toBe("drafted");
 		});
 
 		it("returns resources on success", async () => {
-			const resources = [true, true, true].map((draft) =>
-				resourceStub({ draft })
+			const resources = ["drafted", "drafted", "drafted"].map((status) =>
+				resourceStub({ status })
 			);
 			server.use(
 				http.get("/api/resources", () => {
@@ -87,12 +87,12 @@ describe("ResourceService", () => {
 			server.use(
 				http.patch("/api/resources/:id", async ({ request: req }) => {
 					request = req;
-					return HttpResponse.json({ draft: false });
+					return HttpResponse.json({ status: "published" });
 				})
 			);
-			await service.publish(id);
+			await service.action(id, "published");
 			expect(new URL(request.url).pathname).toMatch(new RegExp(`/${id}$`));
-			await expect(request.json()).resolves.toEqual({ draft: false });
+			await expect(request.json()).resolves.toEqual({ status: "published" });
 		});
 	});
 
@@ -102,7 +102,7 @@ describe("ResourceService", () => {
 			const submitted = { title: "foo bar", url: "https://example.com" };
 			const created = resourceStub({
 				...submitted,
-				draft: true,
+				status: "drafted",
 			});
 			server.use(
 				http.post("/api/resources", ({ request: req }) => {

e2e/fixtures/oneDraftResource.json

@@ -9,7 +9,7 @@
 	],
 	"resources": [
 		{
-			"draft": true,
+			"status": "drafted",
 			"source": "2a8e4bb3-6f9c-4602-b084-af343fcbe6f0",
 			"title": "Joi documentation",
 			"url": "https://joi.dev/"

e2e/fixtures/onePublishedResource.json

@@ -10,7 +10,7 @@
 	"resources": [
 		{
 			"description": "Part 4 of an ongoing series on test-driven development (TDD) in JavaScript.",
-			"draft": false,
+			"status": "published",
 			"source": "2a8e4bb3-6f9c-4602-b084-af343fcbe6f0",
 			"title": "JS TDD Ohm",
 			"url": "https://blog.jonrshar.pe/2023/May/23/js-tdd-ohm.html"

e2e/integration/pagination.test.js

@@ -38,12 +38,12 @@ function createResource(index) {
 	date.setHours(12, 13, 14);
 	const accession = new Date(date.getTime());
 	date.setHours(14, 15, 16);
-	const publication = new Date(date.getTime());
+	const statusChangedDate = new Date(date.getTime());
 	return {
 		accession,
-		draft: false,
-		publication,
-		publisher: admin.id,
+		status: "published",
+		statusChangedDate,
+		statusChangedBy: admin.id,
 		source: user.id,
 		title: `Resource ${id}`,
 		url: `https://example.com/resources/${id}`,

e2e/integration/suggest.test.js

@@ -31,7 +31,7 @@ it("lets an authenticated user suggest a resource", () => {
 			expect(submitted).to.have.property("title", title);
 			expect(submitted).to.have.property("url", url);
 			cy.request({
-				body: { draft: false },
+				body: { status: "published" },
 				headers: { Authorization: `Bearer ${Cypress.env("SUDO_TOKEN")}` },
 				method: "PATCH",
 				url: `/api/resources/${created.id}`,

server/db.js

@@ -111,7 +111,3 @@ export function updateQuery(tableName, columns) {
 			.join(", ")
 	);
 }
-
-export function deleteQuery(tableName) {
-	return format("DELETE FROM %I WHERE id = $1 RETURNING *;", tableName);
-}

server/docs/resources.yml

@@ -14,7 +14,7 @@
 
           **Note**: drafts are only available to admin users or with SUDO token.
         schema:
-          type: boolean
+          type: string
       - in: query
         name: page
         description: Which page of resources to fetch.
@@ -87,11 +87,11 @@
         application/json:
           schema:
             type: object
-            required: [draft]
+            required: [status]
             properties:
-              draft:
-                type: boolean
-                example: false
+              status:
+                type: string
+                example: "published"
     responses:
       200:
         content:

server/docs/schema.yml

@@ -81,12 +81,12 @@ components:
       allOf:
         - $ref: "#/components/schemas/BaseResource"
         - type: object
-          required: [draft]
+          required: [status]
           properties:
-            draft:
-              type: boolean
-              example: true
-            publication:
+            status:
+              type: string
+              example: "drafted"
+            statusChangedDate:
               type: string
               example: null
               nullable: true
@@ -102,15 +102,15 @@ components:
       allOf:
         - $ref: "#/components/schemas/BaseResource"
         - type: object
-          required: [draft, publication]
+          required: [status, statusChangedDate]
           properties:
-            draft:
-              example: false
-            publication:
+            status:
+              example: "published"
+            statusChangedDate:
               type: string
               format: date-time
               nullable: false
-            publisher:
+            statusChangedBy:
               description: |
                 The ID of the user who published the resource (or `null`, if the SUDO token was used).
               type: string

server/resources/resources.test.js

@@ -23,7 +23,7 @@ describe("/api/resources", () => {
 			expect(body).toMatchObject({
 				accession: expect.stringMatching(patterns.DATETIME),
 				description: null,
-				draft: true,
+				status: "drafted",
 				id: expect.stringMatching(patterns.UUID),
 				source: id,
 				title: resource.title,
@@ -160,7 +160,7 @@ describe("/api/resources", () => {
 				const { agent: adminAgent } = await authenticateAs("admin");
 				const { body: envelope } = await adminAgent
 					.get("/api/resources")
-					.query({ draft: true })
+					.query({ status: "drafted" })
 					.set("User-Agent", "supertest")
 					.expect(200);
 				expect(envelope).toEqual({
@@ -179,7 +179,7 @@ describe("/api/resources", () => {
 				const { agent: adminAgent } = await authenticateAs("admin");
 				const { body: envelope } = await adminAgent
 					.get("/api/resources")
-					.query({ draft: true, page: 2, perPage: 10 })
+					.query({ status: "drafted", page: 2, perPage: 10 })
 					.set("User-Agent", "supertest")
 					.expect(200);
 				expect(envelope).toEqual({
@@ -198,7 +198,7 @@ describe("/api/resources", () => {
 				const { agent } = await authenticateAs("admin");
 				await agent
 					.get("/api/resources")
-					.query({ draft: true, page: 0, perPage: "foo" })
+					.query({ status: "drafted", page: 0, perPage: "foo" })
 					.set("User-Agent", "supertest")
 					.expect(400, {
 						page: '"page" must be greater than or equal to 1',
@@ -221,7 +221,7 @@ describe("/api/resources", () => {
 				body: { resources },
 			} = await anonAgent
 				.get("/api/resources")
-				.query({ draft: true })
+				.query({ status: "drafted" })
 				.set("Authorization", `Bearer ${sudoToken}`)
 				.set("User-Agent", "supertest")
 				.expect(200);
@@ -242,7 +242,7 @@ describe("/api/resources", () => {
 
 			await anonAgent
 				.get("/api/resources")
-				.query({ draft: true })
+				.query({ status: "drafted" })
 				.set("User-Agent", "supertest")
 				.expect(403, "Forbidden");
 		});
@@ -269,15 +269,15 @@ describe("/api/resources", () => {
 
 			const {
 				body: {
-					resources: [draft],
+					resources: [status],
 				},
 			} = await anonAgent
 				.get("/api/resources")
-				.query({ draft: true })
+				.query({ status: "drafted" })
 				.set("Authorization", `Bearer ${sudoToken}`)
 				.set("User-Agent", "supertest")
 				.expect(200);
-			expect(draft).toHaveProperty("topic_name", topic.name);
+			expect(status).toHaveProperty("topic_name", topic.name);
 		});
 	});
 
@@ -296,16 +296,16 @@ describe("/api/resources", () => {
 
 			const { body: updated } = await anonAgent
 				.patch(`/api/resources/${resource.id}`)
-				.send({ draft: false })
+				.send({ status: "published" })
 				.set("Authorization", `Bearer ${sudoToken}`)
 				.set("User-Agent", "supertest")
 				.expect(200);
 
 			expect(updated).toEqual({
 				...resource,
-				draft: false,
-				publication: expect.stringMatching(patterns.DATETIME),
-				publisher: null,
+				status: "published",
+				status_changed_date: expect.stringMatching(patterns.DATETIME),
+				status_changed_by: null,
 			});
 
 			const {
@@ -328,11 +328,11 @@ describe("/api/resources", () => {
 
 			await anonAgent
 				.patch(`/api/resources/${resource.id}`)
-				.send({ draft: true, title: "Something else" })
+				.send({ status: "drafted", title: "Something else" })
 				.set("Authorization", `Bearer ${sudoToken}`)
 				.set("User-Agent", "supertest")
 				.expect(400, {
-					draft: '"draft" must be [false]',
+					status: '"status" must be one of [rejected, published]',
 					title: '"title" is not allowed',
 				});
 		});
@@ -341,7 +341,7 @@ describe("/api/resources", () => {
 			const { agent } = await authenticateAs("anonymous");
 			await agent
 				.patch(`/api/resources/${randomUUID()}`)
-				.send({ draft: false })
+				.send({ status: "published" })
 				.set("Authorization", `Bearer ${sudoToken}`)
 				.set("User-Agent", "supertest")
 				.expect(404);
@@ -361,7 +361,7 @@ describe("/api/resources", () => {
 
 			await anonAgent
 				.patch(`/api/resources/${resource.id}`)
-				.send({ draft: false })
+				.send({ status: "published" })
 				.set("User-Agent", "supertest")
 				.expect(401);
 		});
@@ -378,11 +378,14 @@ describe("/api/resources", () => {
 
 			const { body: published } = await adminAgent
 				.patch(`/api/resources/${created.id}`)
-				.send({ draft: false })
+				.send({ status: "published" })
 				.set("User-Agent", "supertest")
 				.expect(200);
 
-			expect(published).toMatchObject({ publisher: admin.id, source: user.id });
+			expect(published).toMatchObject({
+				status_changed_by: admin.id,
+				source: user.id,
+			});
 		});
 	});
 });