phoenix-api: refactor sendApiResponse

skerkour · Dec 6, 2023 · 859f013 · 859f013
1 parent a5c88ca
commit 859f013
Show file tree

Hide file tree

Showing 17 changed files with 39 additions and 40 deletions.
diff --git a/packages/core/api.ts b/packages/core/api.ts
@@ -1,12 +1,11 @@
 import { z } from 'zod';
 import { PageType, type User } from './entities';
 import deepClone from '@phoenix/deepclone';
-import type { ApiResponse } from './api_client';
 
 export * from './api_client';
 export * from './api_routes';
 
-export function convertToApiResponse<T>(data: T): ApiResponse<T> {
+export function convertToApiResponse<T>(data: T): any {
   return {
     data: data,
     error: null,

diff --git a/phoenix-api/src/blogs/create_blog.ts b/phoenix-api/src/blogs/create_blog.ts
@@ -1,5 +1,5 @@
 import { uuidv7 } from "@phoenix/uuidv7";
-import { checkAuth, checkIsAdmin, newApiResponse, parseAndValidateApiInput } from "../utils";
+import { checkAuth, checkIsAdmin, parseAndValidateApiInput, sendApiResponse } from "../utils";
 import { CreateBlogInputValidator } from "@phoenix/core/api";
 import { Blog } from "@phoenix/core/entities";
 import { Context } from "../hono_bindings";
@@ -28,5 +28,5 @@ export async function createBlog(ctx: Context): Promise<Response> {
       JSON.stringify(blog.navigation), blog.description_html)
     .run();
 
-  return newApiResponse(blog);
+  return sendApiResponse(ctx, blog);
 }
diff --git a/phoenix-api/src/blogs/create_page.ts b/phoenix-api/src/blogs/create_page.ts
@@ -1,4 +1,4 @@
-import { checkAuth, newApiResponse, parseAndValidateApiInput } from "../utils";
+import { checkAuth, parseAndValidateApiInput, sendApiResponse } from "../utils";
 import { NotFoundError } from "@phoenix/core/errors";
 import { uuidv7 } from "@phoenix/uuidv7";
 import { checkIsAdmin } from "../utils";
@@ -44,5 +44,5 @@ export async function createPage(ctx: Context): Promise<Response> {
   .bind(now.toISOString(), blog.id)
   .run();
 
-  return newApiResponse(page);
+  return sendApiResponse(ctx, page);
 }
diff --git a/phoenix-api/src/blogs/delete_blog.ts b/phoenix-api/src/blogs/delete_blog.ts
@@ -1,5 +1,5 @@
 import { Context } from "../hono_bindings";
-import { checkAuth, checkIsAdmin, newApiResponse, parseAndValidateApiInput } from "../utils";
+import { checkAuth, checkIsAdmin, parseAndValidateApiInput, sendApiResponse } from "../utils";
 import { DeleteBlogInputValidator } from "@phoenix/core/api";
 
 export async function deleteBlog(ctx: Context): Promise<Response> {
@@ -12,5 +12,5 @@ export async function deleteBlog(ctx: Context): Promise<Response> {
     .bind(apiInput.blog_id)
     .run();
 
-  return newApiResponse({ ok: true });
+  return sendApiResponse(ctx, { ok: true });
 }
diff --git a/phoenix-api/src/blogs/delete_page.ts b/phoenix-api/src/blogs/delete_page.ts
@@ -1,6 +1,6 @@
 import { NotFoundError } from "@phoenix/core/errors";
 import { Context } from "../hono_bindings";
-import { checkAuth, checkIsAdmin, newApiResponse, parseAndValidateApiInput } from "../utils";
+import { checkAuth, checkIsAdmin, parseAndValidateApiInput, sendApiResponse } from "../utils";
 import { DeletePageInputValidator } from "@phoenix/core/api";
 import { Page, PageValidator } from "@phoenix/core/entities";
 
@@ -23,5 +23,5 @@ export async function deletePage(ctx: Context): Promise<Response> {
     .bind(apiInput.page_id)
     .run();
 
-  return newApiResponse({ ok: true });
+  return sendApiResponse(ctx, { ok: true });
 }
diff --git a/phoenix-api/src/blogs/get_blog.ts b/phoenix-api/src/blogs/get_blog.ts
@@ -1,5 +1,5 @@
 import { Context } from "../hono_bindings";
-import { checkAuth, newApiResponse, parseAndValidateApiInput } from "../utils";
+import { checkAuth, parseAndValidateApiInput, sendApiResponse } from "../utils";
 import { NotFoundError } from "@phoenix/core/errors";
 import { GetBlogInputValidator } from "@phoenix/core/api";
 import { parseBlogFromDB } from "./utils";
@@ -17,5 +17,5 @@ export async function getBlog(ctx: Context): Promise<Response> {
   }
   const blog = parseBlogFromDB(blogRes);
 
-  return newApiResponse(blog);
+  return sendApiResponse(ctx, blog);
 }
diff --git a/phoenix-api/src/blogs/get_blogs.ts b/phoenix-api/src/blogs/get_blogs.ts
@@ -1,5 +1,5 @@
 import { Context } from "../hono_bindings";
-import { checkAuth, newApiResponse } from "../utils";
+import { checkAuth, sendApiResponse } from "../utils";
 import { parseBlogFromDB } from "./utils";
 
 export async function getBlogs(ctx: Context): Promise<Response> {
@@ -8,5 +8,5 @@ export async function getBlogs(ctx: Context): Promise<Response> {
   const blogsRes = (await ctx.env.DB.prepare('SELECT * FROM blogs ORDER BY id DESC').all()).results;
   const blogs = blogsRes.map(parseBlogFromDB);
 
-  return newApiResponse(blogs);
+  return sendApiResponse(ctx, blogs);
 }
diff --git a/phoenix-api/src/blogs/get_page.ts b/phoenix-api/src/blogs/get_page.ts
@@ -1,5 +1,5 @@
 import { Context } from "../hono_bindings";
-import { checkAuth, newApiResponse, parseAndValidateApiInput } from "../utils";
+import { checkAuth, parseAndValidateApiInput, sendApiResponse } from "../utils";
 import { NotFoundError } from "@phoenix/core/errors";
 import { GetPageInputValidator } from "@phoenix/core/api";
 import { Page, PageValidator } from "@phoenix/core/entities";
@@ -17,5 +17,5 @@ export async function getPage(ctx: Context): Promise<Response> {
   }
   const page = PageValidator.parse(pageRes);
 
-  return newApiResponse(page);
+  return sendApiResponse(ctx, page);
 }
diff --git a/phoenix-api/src/blogs/get_pages.ts b/phoenix-api/src/blogs/get_pages.ts
@@ -1,5 +1,5 @@
 import { Context } from "../hono_bindings";
-import { checkAuth, newApiResponse, parseAndValidateApiInput } from "../utils";
+import { checkAuth, parseAndValidateApiInput, sendApiResponse } from "../utils";
 import { GetPagesInputValidator } from "@phoenix/core/api";
 import { PageValidator } from "@phoenix/core/entities";
 
@@ -13,5 +13,5 @@ export async function getPages(ctx: Context): Promise<Response> {
     .all();
   const pages = pagesRes.results.map((p) => PageValidator.parse(p));
 
-  return newApiResponse(pages);
+  return sendApiResponse(ctx, pages);
 }
diff --git a/phoenix-api/src/blogs/headless_get_blog.ts b/phoenix-api/src/blogs/headless_get_blog.ts
@@ -1,7 +1,7 @@
 import { Context } from "../hono_bindings";
 import { NotFoundError } from "@phoenix/core/errors";
 import { parseBlogFromDB } from "./utils";
-import { newApiResponse } from "../utils";
+import { sendApiResponse } from "../utils";
 
 export async function headlessGetBlog(ctx: Context): Promise<Response> {
   const blogDomainInput = ctx.req.query('domain')?.trim() ?? '';
@@ -15,5 +15,5 @@ export async function headlessGetBlog(ctx: Context): Promise<Response> {
   }
   const blog = parseBlogFromDB(blogRes);
 
-  return newApiResponse(blog);
+  return sendApiResponse(ctx, blog);
 }
diff --git a/phoenix-api/src/blogs/headless_get_page.ts b/phoenix-api/src/blogs/headless_get_page.ts
@@ -1,7 +1,7 @@
 import { Context } from "../hono_bindings";
 import { NotFoundError } from "@phoenix/core/errors";
 import { PageValidator } from "@phoenix/core/entities";
-import { newApiResponse } from "../utils";
+import { sendApiResponse } from "../utils";
 
 export async function headlessGetPage(ctx: Context): Promise<Response> {
   const pageSlug = ctx.req.query('slug')?.trim() ?? '';
@@ -19,5 +19,5 @@ export async function headlessGetPage(ctx: Context): Promise<Response> {
   }
   const page = PageValidator.parse(pageRes);
 
-  return newApiResponse(page);
+  return sendApiResponse(ctx, page);
 }
diff --git a/phoenix-api/src/blogs/headless_get_posts.ts b/phoenix-api/src/blogs/headless_get_posts.ts
@@ -1,6 +1,6 @@
 import { Context } from "../hono_bindings";
 import { PageValidator } from "@phoenix/core/entities";
-import { newApiResponse } from "../utils";
+import { sendApiResponse } from "../utils";
 
 export async function headlessGetPosts(ctx: Context): Promise<Response> {
   const blogDomainInput = ctx.req.query('domain')?.trim() ?? '';
@@ -16,5 +16,5 @@ export async function headlessGetPosts(ctx: Context): Promise<Response> {
   const pages = pagesRes.results.map((p) => PageValidator.parse(p));
 
 
-  return newApiResponse(pages);
+  return sendApiResponse(ctx, pages);
 }
diff --git a/phoenix-api/src/blogs/update_blog.ts b/phoenix-api/src/blogs/update_blog.ts
@@ -1,5 +1,5 @@
 import { Context } from "../hono_bindings";
-import { checkAuth, checkIsAdmin, newApiResponse, parseAndValidateApiInput } from "../utils";
+import { checkAuth, checkIsAdmin, parseAndValidateApiInput, sendApiResponse } from "../utils";
 import { NotFoundError } from "@phoenix/core/errors";
 import { UpdateBlogInputValidator } from "@phoenix/core/api";
 import { parseBlogFromDB } from "./utils";
@@ -31,5 +31,5 @@ export async function updateBlog(ctx: Context): Promise<Response> {
       blog.description_html, blog.id)
     .run();
 
-  return newApiResponse(blog);
+  return sendApiResponse(ctx, blog);
 }
diff --git a/phoenix-api/src/blogs/update_page.ts b/phoenix-api/src/blogs/update_page.ts
@@ -1,5 +1,5 @@
 import { Context } from "../hono_bindings";
-import { checkAuth, checkIsAdmin, newApiResponse, parseAndValidateApiInput } from "../utils";
+import { checkAuth, checkIsAdmin, parseAndValidateApiInput, sendApiResponse } from "../utils";
 import { NotFoundError } from "@phoenix/core/errors";
 import { UpdatePageInputValidator } from "@phoenix/core/api";
 import { PageValidator } from "@phoenix/core/entities";
@@ -30,5 +30,5 @@ export async function updatePage(ctx: Context): Promise<Response> {
     .bind(page.updated_at.toISOString(), page.slug, page.title, page.content_html, page.id)
     .run();
 
-  return newApiResponse(page);
+  return sendApiResponse(ctx, page);
 }
diff --git a/phoenix-api/src/users/login.ts b/phoenix-api/src/users/login.ts
@@ -2,7 +2,7 @@ import { setCookie } from "hono/cookie";
 import { Context } from "../hono_bindings";
 import jwt from "@phoenix/jwt";
 import { NotFoundError, PermissionDeniedError } from "@phoenix/core/errors";
-import { base64ToBuffer, hashPassword, newApiResponse, parseAndValidateApiInput } from "../utils";
+import { base64ToBuffer, hashPassword, parseAndValidateApiInput, sendApiResponse } from "../utils";
 import { LoginInputValidator, convertUser } from "@phoenix/core/api";
 import { UserValidator } from "@phoenix/core/entities";
 
@@ -37,5 +37,5 @@ export async function login(ctx: Context): Promise<Response> {
     { httpOnly: false, expires: expiresAt, sameSite: 'Lax', secure: true, path: '/' },
   );
 
-  return newApiResponse(convertUser(user));
+  return sendApiResponse(ctx, convertUser(user));
 }
diff --git a/phoenix-api/src/users/signup.ts b/phoenix-api/src/users/signup.ts
@@ -1,4 +1,4 @@
-import { bufferToBase64, hashPassword, newApiResponse, parseAndValidateApiInput } from "../utils";
+import { bufferToBase64, hashPassword, parseAndValidateApiInput, sendApiResponse } from "../utils";
 import { uuidv7 } from "@phoenix/uuidv7";
 import { PermissionDeniedError } from "@phoenix/core/errors";
 import { User } from "@phoenix/core/entities";
@@ -60,5 +60,5 @@ export async function signup(ctx: Context): Promise<Response> {
     { httpOnly: false, expires: expiresAt, sameSite: 'Lax', secure: true, path: '/' },
   );
 
-  return newApiResponse(convertUser(user));
+  return sendApiResponse(ctx, convertUser(user));
 }
diff --git a/phoenix-api/src/utils.ts b/phoenix-api/src/utils.ts
@@ -4,17 +4,17 @@ import { InvalidArgumentError, NotFoundError, PermissionDeniedError } from "@pho
 import jwt from "@phoenix/jwt";
 import { ZodSchema } from "zod";
 import { UserValidator } from "@phoenix/core/entities";
+import { ApiResponse } from "@phoenix/core/api_client";
 
-export function newApiResponse<T>(data: T, status = 200): Response {
-  return new Response(JSON.stringify({ data, error: null }), {
-    status: status,
-    headers: {
-      'content-type': 'application/json'
-    },
-  });
+export function sendApiResponse<T>(ctx: Context, data: T, status = 200): Response {
+  const body: ApiResponse<T> = {
+    data: data,
+    error: null,
+  };
+  // we convert to any because hono's json function is too restrictive (doesn't accept Date...)
+  return ctx.json(body as any, status);
 }
 
-
 /**
  * Hash the given password with `PBKDF2-SHA-512` using userId as a salt
  */