feat: add emoji versions API endpoint and error handling

Author: luxass

src/index.ts

@@ -4,14 +4,11 @@ import { OpenAPIHono } from "@hono/zod-openapi";
 import { apiReference } from "@scalar/hono-api-reference";
 import { env } from "hono/adapter";
 import { HTTPException } from "hono/http-exception";
+import { VERSIONS_ROUTER } from "./routes/versions";
 
 const app = new OpenAPIHono<HonoContext>();
 
-app.get("/", async (c) => {
-  return c.json({
-    message: "Hello, World!",
-  });
-});
+app.route("/api/v1", VERSIONS_ROUTER);
 
 app.get(
   "/scalar",
@@ -21,15 +18,6 @@ app.get(
     },
     layout: "classic",
     customCss: /* css */`
-    .section.introduction-section {
-      padding: 16px 0 !important;
-    }
-
-    .section-container {
-      border: none !important;
-      padding: 0 !important;
-    }
-
     .tag-section {
       padding: 0 !important;
     }

src/routes/versions.openapi.ts

@@ -0,0 +1,26 @@
+import { createRoute, z } from "@hono/zod-openapi";
+import { ApiErrorSchema, EmojiVersion } from "../schemas";
+
+export const ALL_EMOJI_VERSIONS_ROUTE = createRoute({
+  method: "get",
+  path: "/versions",
+  tags: ["Misc"],
+  responses: {
+    200: {
+      content: {
+        "application/json": {
+          schema: z.array(EmojiVersion),
+        },
+      },
+      description: "Retrieve a list of all emoji versions available",
+    },
+    500: {
+      content: {
+        "application/json": {
+          schema: ApiErrorSchema,
+        },
+      },
+      description: "Internal Server Error",
+    },
+  },
+});

src/routes/versions.ts

@@ -0,0 +1,33 @@
+import type { HonoContext } from "../types";
+import { OpenAPIHono, z } from "@hono/zod-openapi";
+import { createError } from "../utils";
+import { ALL_EMOJI_VERSIONS_ROUTE } from "./versions.openapi";
+
+export const VERSIONS_ROUTER = new OpenAPIHono<HonoContext>();
+
+const EMOJI_LOCK_SCHEMA = z.object({
+  versions: z.array(z.string()),
+});
+
+VERSIONS_ROUTER.openapi(ALL_EMOJI_VERSIONS_ROUTE, async (c) => {
+  const res = await fetch("https://raw.githubusercontent.com/mojisdev/emoji-data/refs/heads/main/emojis.lock");
+
+  if (!res.ok) {
+    return createError(c, 500, "failed to fetch emoji data");
+  }
+
+  const data = await res.json();
+
+  const result = EMOJI_LOCK_SCHEMA.safeParse(data);
+
+  if (!result.success) {
+    return createError(c, 500, "invalid emoji data schema");
+  }
+
+  return c.json(
+    result.data.versions.map((version: string) => ({
+      version,
+    })),
+    200,
+  );
+});

src/schemas.ts

@@ -1,5 +1,12 @@
 import { z } from "@hono/zod-openapi";
 
+export const EmojiVersion = z.object({
+  version: z.string().openapi({
+    description: "The emoji version",
+    example: "16.0",
+  }),
+});
+
 export const ApiErrorSchema = z.object({
   path: z.string().openapi({
     description: "The path of the request",

src/utils.ts

@@ -0,0 +1,15 @@
+import type { Context } from "hono";
+import type { ContentfulStatusCode } from "hono/utils/http-status";
+import type { ApiError } from "./schemas";
+
+export function createError<TCtx extends Context, TStatus extends ContentfulStatusCode>(ctx: TCtx, status: TStatus, message: string) {
+  const url = new URL(ctx.req.url);
+  return ctx.json({
+    path: url.pathname,
+    message,
+    status,
+    timestamp: new Date().toISOString(),
+  } satisfies ApiError, status, {
+    "Content-Type": "application/json",
+  });
+}