Implement output types for Article

Author: junlarsen

apps/rpc/src/invariant.ts

@@ -18,3 +18,16 @@ export function parseOrReport<T extends z.ZodSchema>(schema: T, value: z.infer<T
   }
   return result.data
 }
+
+export function parseOutputType<T extends z.ZodSchema>(schema: T, value: z.infer<T> | unknown): z.infer<T> {
+  const result = schema.safeParse(value)
+  if (!result.success) {
+    logger.error(
+      "Procedure handler failed to parse value into schema: %s emitted for object %o",
+      result.error.message,
+      value
+    )
+    throw new Error("Procedure handler returned value that does not conform to schema")
+  }
+  return result.data
+}

apps/rpc/src/modules/article/article-repository.ts

@@ -1,17 +1,15 @@
 import type { DBHandle } from "@dotkomonline/db"
 import {
-  type Article,
-  type ArticleFilterQuery,
+  Article,
   type ArticleId,
-  ArticleSchema,
   type ArticleSlug,
-  type ArticleTag,
+  ArticleTag,
   type ArticleTagName,
-  ArticleTagSchema,
   type ArticleWrite,
-} from "@dotkomonline/types"
+} from "./article-types"
 import { parseOrReport } from "../../invariant"
 import { type Pageable, pageQuery } from "../../query"
+import { ArticleFilterQuery } from "./article-service"
 
 export interface ArticleRepository {
   create(handle: DBHandle, data: ArticleWrite): Promise<Article>
@@ -122,7 +120,7 @@ export function getArticleRepository(): ArticleRepository {
       })
 
       return tags.map((tag) =>
-        parseOrReport(ArticleTagSchema, {
+        parseOrReport(ArticleTag, {
           name: tag.tagName,
         })
       )
@@ -131,7 +129,7 @@ export function getArticleRepository(): ArticleRepository {
 }
 
 function mapArticle(article: Omit<Article, "tags">, tags: { tag: ArticleTag }[]): Article {
-  return parseOrReport(ArticleSchema, {
+  return parseOrReport(Article, {
     ...article,
     tags: tags.map((link) => link.tag),
   })

apps/rpc/src/modules/article/article-router.ts

@@ -1,53 +1,74 @@
 import type { PresignedPost } from "@aws-sdk/s3-presigned-post"
-import { ArticleFilterQuerySchema, ArticleSchema, ArticleTagSchema, ArticleWriteSchema } from "@dotkomonline/types"
+import { Article, ArticleTag, ArticleWrite } from "./article-types"
 import type { inferProcedureInput, inferProcedureOutput } from "@trpc/server"
 import { z } from "zod"
 import { isEditor } from "../../authorization"
 import { withAuditLogEntry, withAuthentication, withAuthorization, withDatabaseTransaction } from "../../middlewares"
 import { BasePaginateInputSchema, PaginateInputSchema } from "../../query"
 import { procedure, t } from "../../trpc"
+import { ArticleFilterQuery } from "./article-service"
+import { parseOutputType } from "src/invariant"
 
-export type CreateArticleInput = inferProcedureInput<typeof createArticleProcedure>
-export type CreateArticleOutput = inferProcedureOutput<typeof createArticleProcedure>
-const createArticleProcedure = procedure
-  .input(
-    z.object({
-      article: ArticleWriteSchema,
-      tags: z.array(ArticleTagSchema.shape.name),
-    })
-  )
-  .use(withAuthentication())
-  .use(withAuthorization(isEditor()))
-  .use(withDatabaseTransaction())
-  .use(withAuditLogEntry())
-  .mutation(async ({ input, ctx }) => {
-    const article = await ctx.articleService.create(ctx.handle, input.article)
-    const tags = await ctx.articleService.setTags(ctx.handle, article.id, input.tags)
-    return {
-      ...article,
-      tags,
-    }
+export const ArticleMessage = Article.pick({
+  id: true,
+  slug: true,
+  title: true,
+  author: true,
+  photographer: true,
+  imageUrl: true,
+  excerpt: true,
+  content: true,
+  isFeatured: true,
+  vimeoId: true,
+  createdAt: true,
+  updatedAt: true,
+  tags: true,
+})
+
+function buildCreateArticleProcedure() {
+  const Input = z.object({
+    article: ArticleWrite,
+    tags: z.array(ArticleTag.shape.name),
   })
+  const Output = ArticleMessage
 
-export type EditArticleInput = inferProcedureInput<typeof editArticleProcedure>
-export type EditArticleOutput = inferProcedureOutput<typeof editArticleProcedure>
-const editArticleProcedure = procedure
-  .input(
-    z.object({
-      id: ArticleSchema.shape.id,
-      input: ArticleWriteSchema.partial(),
-      tags: z.array(ArticleTagSchema.shape.name),
+  return procedure
+    .input(Input)
+    .output(Output)
+    .use(withAuthentication())
+    .use(withAuthorization(isEditor()))
+    .use(withDatabaseTransaction())
+    .use(withAuditLogEntry())
+    .mutation(async ({ input, ctx }) => {
+      const { id } = await ctx.articleService.create(ctx.handle, input.article)
+      await ctx.articleService.setTags(ctx.handle, id, input.tags)
+      const article = await ctx.articleService.getById(ctx.handle, id)
+      return parseOutputType(Output, article)
     })
-  )
-  .use(withAuthentication())
-  .use(withAuthorization(isEditor()))
-  .use(withDatabaseTransaction())
-  .use(withAuditLogEntry())
-  .mutation(async ({ input, ctx }) => {
-    const article = await ctx.articleService.update(ctx.handle, input.id, input.input)
-    const tags = await ctx.articleService.setTags(ctx.handle, input.id, input.tags)
-    return { ...article, tags }
+}
+
+function buildEditArticleProcedure() {
+  const Input = z.object({
+    id: Article.shape.id,
+    input: ArticleWrite.partial(),
+    tags: z.array(ArticleTag.shape.name),
   })
+  const Output = ArticleMessage
+
+  return procedure
+    .input(Input)
+    .output(Output)
+    .use(withAuthentication())
+    .use(withAuthorization(isEditor()))
+    .use(withDatabaseTransaction())
+    .use(withAuditLogEntry())
+    .mutation(async ({ input, ctx }) => {
+      const { id } = await ctx.articleService.update(ctx.handle, input.id, input.input)
+      await ctx.articleService.setTags(ctx.handle, input.id, input.tags)
+      const article = await ctx.articleService.getById(ctx.handle, id)
+      return parseOutputType(Output, article)
+    })
+}
 
 export type AllArticlesInput = inferProcedureInput<typeof allArticlesProcedure>
 export type AllArticlesOutput = inferProcedureOutput<typeof allArticlesProcedure>
@@ -59,7 +80,7 @@ const allArticlesProcedure = procedure
 export type FindArticlesInput = inferProcedureInput<typeof findArticlesProcedure>
 export type FindArticlesOutput = inferProcedureOutput<typeof findArticlesProcedure>
 const findArticlesProcedure = procedure
-  .input(BasePaginateInputSchema.extend({ filters: ArticleFilterQuerySchema }))
+  .input(BasePaginateInputSchema.extend({ filters: ArticleFilterQuery }))
   .use(withDatabaseTransaction())
   .query(async ({ input, ctx }) => {
     const items = await ctx.articleService.findMany(ctx.handle, input.filters, input)
@@ -73,21 +94,22 @@ const findArticlesProcedure = procedure
 export type FindArticleInput = inferProcedureInput<typeof findArticleProcedure>
 export type FindArticleOutput = inferProcedureOutput<typeof findArticleProcedure>
 const findArticleProcedure = procedure
-  .input(ArticleSchema.shape.id)
+  .input(Article.shape.id)
   .use(withDatabaseTransaction())
   .query(async ({ input, ctx }) => ctx.articleService.findById(ctx.handle, input))
 
 export type GetArticleInput = inferProcedureInput<typeof getArticleProcedure>
 export type GetArticleOutput = inferProcedureOutput<typeof getArticleProcedure>
 const getArticleProcedure = procedure
-  .input(ArticleSchema.shape.id)
+  .input(Article.shape.id)
   .use(withDatabaseTransaction())
   .query(async ({ input, ctx }) => ctx.articleService.getById(ctx.handle, input))
 
 export type FindRelatedArticlesInput = inferProcedureInput<typeof findRelatedArticlesProcedure>
 export type FindRelatedArticlesOutput = inferProcedureOutput<typeof findRelatedArticlesProcedure>
 const findRelatedArticlesProcedure = procedure
-  .input(ArticleSchema)
+  // TODO: Accept article id here instead
+  .input(Article)
   .use(withDatabaseTransaction())
   .query(async ({ input, ctx }) => ctx.articleService.findRelated(ctx.handle, input))
 
@@ -118,8 +140,8 @@ export type AddArticleTagOutput = inferProcedureOutput<typeof addArticleTagProce
 const addArticleTagProcedure = procedure
   .input(
     z.object({
-      id: ArticleSchema.shape.id,
-      tag: ArticleTagSchema.shape.name,
+      id: Article.shape.id,
+      tag: ArticleTag.shape.name,
     })
   )
   .use(withAuthentication())
@@ -135,8 +157,8 @@ export type RemoveArticleTagOutput = inferProcedureOutput<typeof removeArticleTa
 const removeArticleTagProcedure = procedure
   .input(
     z.object({
-      id: ArticleSchema.shape.id,
-      tag: ArticleTagSchema.shape.name,
+      id: Article.shape.id,
+      tag: ArticleTag.shape.name,
     })
   )
   .use(withAuthentication())
@@ -164,8 +186,8 @@ const createArticleFileUploadProcedure = procedure
   })
 
 export const articleRouter = t.router({
-  create: createArticleProcedure,
-  edit: editArticleProcedure,
+  create: buildCreateArticleProcedure(),
+  edit: buildEditArticleProcedure(),
   all: allArticlesProcedure,
   findArticles: findArticlesProcedure,
   find: findArticleProcedure,

apps/rpc/src/modules/article/article-service.ts

@@ -1,23 +1,27 @@
 import type { S3Client } from "@aws-sdk/client-s3"
 import type { PresignedPost } from "@aws-sdk/s3-presigned-post"
 import type { DBHandle } from "@dotkomonline/db"
-import type {
-  Article,
-  ArticleFilterQuery,
-  ArticleId,
-  ArticleSlug,
-  ArticleTag,
-  ArticleTagName,
-  ArticleWrite,
-  UserId,
-} from "@dotkomonline/types"
+import { Article, ArticleId, ArticleSlug, ArticleTag, ArticleTagName, ArticleWrite } from "./article-types"
 import { createS3PresignedPost, slugify } from "@dotkomonline/utils"
 import { compareAsc, compareDesc } from "date-fns"
 import { AlreadyExistsError, NotFoundError } from "../../error"
 import type { Pageable } from "../../query"
 import type { ArticleRepository } from "./article-repository"
 import type { ArticleTagLinkRepository } from "./article-tag-link-repository"
 import type { ArticleTagRepository } from "./article-tag-repository"
+import z from "zod"
+import { buildAnyOfFilter, buildSearchFilter, UserId } from "@dotkomonline/types"
+
+/**
+ * Filtering options available for Article
+ */
+export type ArticleFilterQuery = z.infer<typeof ArticleFilterQuery>
+export const ArticleFilterQuery = z
+  .object({
+    bySearchTerm: buildSearchFilter(),
+    byTags: buildAnyOfFilter(ArticleTag.shape.name),
+  })
+  .partial()
 
 export interface ArticleService {
   create(handle: DBHandle, data: ArticleWrite): Promise<Article>

apps/rpc/src/modules/article/article-tag-link-repository.ts

@@ -1,5 +1,5 @@
 import type { DBHandle } from "@dotkomonline/db"
-import type { ArticleId, ArticleTagName } from "@dotkomonline/types"
+import type { ArticleId, ArticleTagName } from "./article-types"
 
 export interface ArticleTagLinkRepository {
   add(handle: DBHandle, articleId: ArticleId, articleTagName: ArticleTagName): Promise<void>

apps/rpc/src/modules/article/article-tag-repository.ts

@@ -1,5 +1,5 @@
 import type { DBHandle } from "@dotkomonline/db"
-import { type ArticleId, type ArticleTag, type ArticleTagName, ArticleTagSchema } from "@dotkomonline/types"
+import { type ArticleId, ArticleTag, type ArticleTagName } from "./article-types"
 import { parseOrReport } from "../../invariant"
 
 export interface ArticleTagRepository {
@@ -19,12 +19,12 @@ export function getArticleTagRepository(): ArticleTagRepository {
         },
       })
 
-      return parseOrReport(ArticleTagSchema.nullable(), tag)
+      return parseOrReport(ArticleTag.nullable(), tag)
     },
 
     async findMany(handle) {
       const tags = await handle.articleTag.findMany()
-      return parseOrReport(ArticleTagSchema.array(), tags)
+      return parseOrReport(ArticleTag.array(), tags)
     },
 
     async create(handle, articleTagName) {
@@ -34,7 +34,7 @@ export function getArticleTagRepository(): ArticleTagRepository {
         },
       })
 
-      return parseOrReport(ArticleTagSchema, tag)
+      return parseOrReport(ArticleTag, tag)
     },
 
     async delete(handle, articleTagName) {
@@ -44,7 +44,7 @@ export function getArticleTagRepository(): ArticleTagRepository {
         },
       })
 
-      return parseOrReport(ArticleTagSchema, tag)
+      return parseOrReport(ArticleTag, tag)
     },
 
     async findManyByArticleId(handle, articleId) {
@@ -60,7 +60,7 @@ export function getArticleTagRepository(): ArticleTagRepository {
         },
       })
 
-      return parseOrReport(ArticleTagSchema.array(), tags)
+      return parseOrReport(ArticleTag.array(), tags)
     },
   }
 }

apps/rpc/src/modules/article/article-types.ts

@@ -0,0 +1,66 @@
+import z from "zod"
+
+/**
+ * Articles may be tagged with one or more tags. Tags themselves only have a name, but are linked through a database
+ * link table.
+ *
+ * @see {ArticleTagLink}
+ */
+export type ArticleTag = z.infer<typeof ArticleTag>
+export type ArticleTagName = ArticleTag["name"]
+export type ArticleTagWrite = z.infer<typeof ArticleTagWrite>
+
+export const ArticleTag = z.object({
+  name: z.string(),
+})
+
+export const ArticleTagWrite = ArticleTag.pick({ name: true })
+
+/**
+ * Domain type for Article
+ *
+ * An article is a blog post written by an OnlineWeb member, typically (but not limited to) somebody from Prokom. Its
+ * contents are stored as rich text content to be rendered by the client.
+ */
+export type Article = z.infer<typeof Article>
+export type ArticleId = Article["id"]
+export type ArticleSlug = Article["slug"]
+export type ArticleWrite = z.infer<typeof ArticleWrite>
+
+export const Article = z.object({
+  id: z.string().uuid(),
+  slug: z.string(),
+  title: z.string(),
+  /**
+   * The stylized name of the author of the post.
+   *
+   * TODO: This should likely be a foreign key to the users table.
+   */
+  author: z.string(),
+  /**
+   * The stylized name of the photographer or artist of the cover image for the article.
+   *
+   * This is intended to be left as a string, as the photographer may be somebody who is not related to Online at all.
+   */
+  photographer: z.string(),
+  imageUrl: z.string().url(),
+  excerpt: z.string(),
+  content: z.string(),
+  isFeatured: z.boolean(),
+  vimeoId: z.string().nullable(),
+  createdAt: z.coerce.date(),
+  updatedAt: z.coerce.date(),
+  tags: z.array(ArticleTag),
+})
+
+export const ArticleWrite = Article.pick({
+  slug: true,
+  title: true,
+  author: true,
+  photographer: true,
+  imageUrl: true,
+  excerpt: true,
+  content: true,
+  isFeatured: true,
+  vimeoId: true,
+})