feat: add api versioning

Author: aurelleb

src/index.ts

@@ -1,15 +1,11 @@
 import { Hono } from 'hono'
 import type { AppContext } from './types/app.js';
-import { createStorageFromEnv, LocalStorageAdapter } from './storage/index.js'
-import extensionsRouter from './routes/extensions.js'
-import localStorageRouter from './routes/storage.js'
 import { prisma } from './db.js';
 import { VALID_PLATFORMS } from './constants/platforms.js';
+import { createStorageFromEnv, LocalStorageAdapter } from './storage/index.js';
 import { ipMiddleware } from './middleware/ip.js';
-
-const app = new Hono<AppContext>()
-const storage = createStorageFromEnv();
-const baseUrl = process.env.API_BASE_URL || 'http://localhost:3000';
+import storageRouter from './routes/storage.js';
+import v1 from './routes/v1';
 
 await prisma.$transaction(
 	VALID_PLATFORMS.map(p => prisma.extensionPlatform.upsert({
@@ -19,24 +15,24 @@ await prisma.$transaction(
 	})),
 );
 
-// Extract client IP from reverse proxy headers
+const app = new Hono<AppContext>()
+const storage = createStorageFromEnv();
+
 app.use('*', ipMiddleware());
 
-// Inject shared context variables
 app.use('*', async (c, next) => {
   c.set('storage', storage)
-  c.set('baseUrl', baseUrl)
   await next()
 })
 
+if (storage instanceof LocalStorageAdapter) {
+	app.route('/', storageRouter);
+}
+
 app.get('/', (c) => {
   return c.json({ message: 'Vicinae Backend' })
 })
 
-app.route('/', extensionsRouter)
-
-if (storage instanceof LocalStorageAdapter) {
-	app.route('/', localStorageRouter);
-}
+app.route('/v1', v1);
 
-export default app
+export default app;

src/routes/v1/index.ts

@@ -0,0 +1,26 @@
+import { Hono } from 'hono';
+import { createStorageFromEnv, LocalStorageAdapter } from '../../storage/index.js';
+import type { AppContext } from '../../types/app.js';
+import storeRouter from './store.js'
+import localStorageRouter from '../storage.js'
+
+const storage = createStorageFromEnv();
+const baseUrl = process.env.API_BASE_URL || 'http://localhost:3000';
+
+const v1 = new Hono<AppContext>()
+
+// Inject shared context variables
+v1.use('*', async (c, next) => {
+  c.set('baseUrl', `${baseUrl}/v1`)
+  await next()
+
+})
+
+v1.route('/store', storeRouter)
+
+if (storage instanceof LocalStorageAdapter) {
+	v1.route('/', localStorageRouter);
+}
+
+export default v1;
+

src/routes/extensions.ts src/routes/v1/store.tssrc/routes/extensions.ts renamed to src/routes/v1/store.ts

@@ -1,18 +1,18 @@
 import { Hono } from 'hono';
-import type { StorageAdapter } from '../storage/index.js';
-import manifestSchema from '../schemas/manifest.js';
+import type { StorageAdapter } from '../../storage/index.js';
+import manifestSchema from '../../schemas/manifest.js';
 import { z } from 'zod';
 import * as JSZip from 'jszip';
-import { prisma } from '../db.js';
-import { computeChecksum } from '../utils/checksum.js';
-import { updateTrendingStatus } from '../utils/trending.js';
-import { getGitHubAvatarUrl } from '../utils/avatar.js';
-import { fetchGitHubUser, getDisplayName } from '../utils/github.js';
-import { getExtensionGitHubUrls, buildAssetUrl } from '../utils/repository.js';
-import { parseIcon } from '../utils/icons.js';
-import { getMimeType } from '../utils/mime.js';
-import type { AppContext } from '../types/app.js';
-import { slugify } from '../utils/slugify.js';
+import { prisma } from '../../db.js';
+import { computeChecksum } from '../../utils/checksum.js';
+import { updateTrendingStatus } from '../../utils/trending.js';
+import { getGitHubAvatarUrl } from '../../utils/avatar.js';
+import { fetchGitHubUser, getDisplayName } from '../../utils/github.js';
+import { getExtensionGitHubUrls, buildAssetUrl } from '../../utils/repository.js';
+import { parseIcon } from '../../utils/icons.js';
+import { getMimeType } from '../../utils/mime.js';
+import type { AppContext } from '../../types/app.js';
+import { slugify } from '../../utils/slugify.js';
 
 const app = new Hono<AppContext>();
 
@@ -111,7 +111,7 @@ async function formatExtensionResponse(
 		})
 	);
 
-	const downloadUrl = `${baseUrl}/extensions/${authorHandle.toLowerCase()}/${extension.name}/download`;
+	const downloadUrl = `${baseUrl}/store/${authorHandle.toLowerCase()}/${extension.name}/download`;
 
 	return {
 		id: extension.id,
@@ -457,7 +457,7 @@ app.post('/extension/upload', async (c) => {
   }
 });
 
-app.get('/extensions/categories', async (c) => {
+app.get('/categories', async (c) => {
 	const categories = await prisma.extensionCategory.findMany({
 		select: {
 			id: true,
@@ -473,7 +473,7 @@ app.get('/extensions/categories', async (c) => {
 	})));
 });
 
-app.get('/extensions/search', async (c) => {
+app.get('/search', async (c) => {
 	try {
 		const query = c.req.query('q');
 		const page = Math.max(1, parseInt(c.req.query('page') || '1', 10));
@@ -559,7 +559,7 @@ app.get('/extensions/search', async (c) => {
 const downloadIpMap = new Map<string, Set<string>>();
 
 // Get detailed information about a specific extension
-app.get('/extensions/:author/:name', async (c) => {
+app.get('/:author/:name', async (c) => {
 	const author = c.req.param('author');
 	const name = c.req.param('name');
 	const storage = c.var.storage;
@@ -578,7 +578,7 @@ app.get('/extensions/:author/:name', async (c) => {
 // Download zip archive and count download
 // We use an in-memory IP map to not duplicate downloads for the same IP per extension.
 // GitHub usernames are case-insensitive, so we normalize to lowercase for lookups
-app.get('/extensions/:author/:name/download', async (c) => {
+app.get('/:author/:name/download', async (c) => {
 	const author = c.req.param('author').toLowerCase(); // Normalize to lowercase
 	const name = c.req.param('name');
 	const storage = c.var.storage;
@@ -619,7 +619,7 @@ app.get('/extensions/:author/:name/download', async (c) => {
 	});
 });
 
-app.get('/extensions/list', async (c) => {
+app.get('/list', async (c) => {
   try {
     const page = Math.max(1, parseInt(c.req.query('page') || '1', 10));
     const limit = Math.min(
@@ -693,7 +693,7 @@ app.get('/extensions/list', async (c) => {
   }
 });
 
-app.post('/extensions/update-trending', async (c) => {
+app.post('/update-trending', async (c) => {
   const authHeader = c.req.header('Authorization');
   if (!authHeader || authHeader !== `Bearer ${API_SECRET}`) {
     return c.json({ error: 'Unauthorized' }, 401);

src/types/app.ts

@@ -5,5 +5,6 @@ export type AppContext = {
     storage: StorageAdapter
     clientIp: string
     baseUrl: string
+	version: `v${number}`;
   }
 }