wip

Author: omargfh

.vscode/settings.json

@@ -63,10 +63,6 @@
     "**/test-dist": true,
     "**/.output": true,
     "**/.data": true,
-    "apps/docs/": true,
-    "apps/learn": true,
-    "apps/netlogo": true,
-    "apps/nettango": true,
   },
 
   "cSpell.words": ["autogen", "iconify", "netlogo", "Nuxt", "Pathnames", "reka", "vueuse"]

apps/modeling-commons-backend/.adminjs/bundle.js

@@ -0,0 +1 @@
+AdminJS.UserComponents = {}

apps/modeling-commons-backend/.adminjs/entry.js

@@ -44,6 +44,9 @@
     "seed": "tsx prisma/seed.ts"
   },
   "dependencies": {
+    "@adminjs/fastify": "^4.2.0",
+    "@adminjs/prisma": "^5.0.4",
+    "@adminjs/sql": "^2.2.6",
     "@fastify/autoload": "6.3.1",
     "@fastify/awilix": "8.2.0",
     "@fastify/cors": "11.2.0",
@@ -62,6 +65,8 @@
     "@prisma/adapter-pg": "^7.6.0",
     "@prisma/client": "latest",
     "@repo/modeling-commons-shared": "0.0.0",
+    "@scalar/fastify-api-reference": "^1.49.7",
+    "adminjs": "^7.8.17",
     "ajv": "8.18.0",
     "ajv-formats": "3.0.1",
     "awilix": "13.0.3",

apps/modeling-commons-backend/package.json

@@ -27,12 +27,12 @@ echo "Server is ready (took ${elapsed}s)"
 
 # ── Generate REST types (OpenAPI) ───────────────────────────────────────────
 echo "Generating REST client types…"
-openapi-typescript "$SERVER_URL/api-docs/json" -o ./client/rest.d.ts
+openapi-typescript "$SERVER_URL/api-docs/openapi.json" -o ./client/rest.d.ts
 echo "Done — client types written to client/"
 
 # if env CLIENT_TYPES_OUTPUT_DIR is set, also write to that location (for CI)
 if [ -n "${CLIENT_TYPES_OUTPUT_DIR:-}" ]; then
   echo "Also writing REST client types to ${CLIENT_TYPES_OUTPUT_DIR}"
-  openapi-typescript "$SERVER_URL/api-docs/json" -o "${CLIENT_TYPES_OUTPUT_DIR}"
+  openapi-typescript "$SERVER_URL/api-docs/openapi.json" -o "${CLIENT_TYPES_OUTPUT_DIR}"
   echo "Done — client types written to ${CLIENT_TYPES_OUTPUT_DIR}"
 fi

apps/modeling-commons-backend/scripts/generate-types.sh

@@ -0,0 +1,11 @@
+const adminJsDependencies = {
+  getAdapter: () => import('@adminjs/prisma'),
+  getDbModule: () => import('#prisma/client'),
+  getDbClient: async () => {
+    return (await import('#src/lib/prisma.ts')).default;
+  },
+};
+
+export type AdminJsDependencies = typeof adminJsDependencies;
+
+export default adminJsDependencies;

apps/modeling-commons-backend/src/lib/adminjs.ts

@@ -1,6 +1,7 @@
 import env from '#src/config/env.ts';
 import { betterAuth } from 'better-auth';
 import { prismaAdapter } from 'better-auth/adapters/prisma';
+import { openAPI } from 'better-auth/plugins';
 
 import { prisma } from './prisma.ts';
 
@@ -15,6 +16,7 @@ export const auth = betterAuth({
   emailAndPassword: {
     enabled: true,
   },
+  plugins: [openAPI({ disableDefaultReference: false })],
 });
 
 export type Session = typeof auth.$Infer.Session;

apps/modeling-commons-backend/src/lib/auth.ts

@@ -12,6 +12,7 @@ export default async function fileRoutes(fastify: FastifyInstance) {
       schema: {
         params: fileIdParamsSchema,
         response: { 200: fileResponseDtoSchema },
+        tags: ['File'],
       },
       preHandler: [requireAuth],
     },
@@ -24,7 +25,7 @@ export default async function fileRoutes(fastify: FastifyInstance) {
   fastify.get<{ Params: FileIdParams }>(
     '/v1/files/:id/download',
     {
-      schema: { params: fileIdParamsSchema },
+      schema: { params: fileIdParamsSchema, tags: ['File'] },
       preHandler: [requireAuth],
     },
     async (request, reply) => {

apps/modeling-commons-backend/src/modules/file/file.route.ts

@@ -8,6 +8,8 @@ import makePrismaTransactionManager from '#src/shared/db/prisma-transaction.mana
 import type { TransactionManager } from '#src/shared/db/transaction.port.ts';
 import { asFunction, asValue, type Resolver } from 'awilix';
 import type { FastifyBaseLogger } from 'fastify';
+import type { AdminJsDependencies } from '#src/lib/adminjs.ts';
+import adminJsDependencies from '#src/lib/adminjs.ts';
 
 type Resolvers<T> = {
   [K in keyof T]: Resolver<T[K]>;

apps/modeling-commons-backend/src/modules/index.ts

@@ -21,6 +21,7 @@ export default async function modelAdditionalFileRoutes(fastify: FastifyInstance
       schema: {
         params: modelIdParamsSchema,
         response: { 201: modelAdditionalFileResponseDtoSchema },
+        tags: ['Model', 'File'],
       },
       preHandler: [requireAuth, resolveModel('write')],
     },
@@ -58,14 +59,12 @@ export default async function modelAdditionalFileRoutes(fastify: FastifyInstance
     {
       schema: {
         params: additionalFileParamsSchema,
+        tags: ['Model', 'File'],
       },
       preHandler: [requireAuth, resolveModel('admin')],
     },
     async (request, reply) => {
-      await modelAdditionalFileService.remove(
-        request.params.fileId,
-        request.user!.id,
-      );
+      await modelAdditionalFileService.remove(request.params.fileId, request.user!.id);
       return reply.code(204).send();
     },
   );
@@ -77,6 +76,7 @@ export default async function modelAdditionalFileRoutes(fastify: FastifyInstance
         params: modelIdParamsSchema,
         querystring: listAdditionalFilesQuerySchema,
         response: { 200: Type.Array(modelAdditionalFileResponseDtoSchema) },
+        tags: ['Model', 'File'],
       },
       preHandler: [resolveModel('read')],
     },