feat: schema server

Author: nicokant

.github/workflows/docker.yaml

@@ -20,19 +20,32 @@ jobs:
       matrix:
         variant:
           - name: public
-            config_branch: main
-            suffix: "-readonly"
-            edit: "true"
+            image_suffix: ""
+            tag_suffix: "-readonly"
+            target: ""
+            build_args: |
+              VITE_DEFAULT_CONFIGURATION=https://s3-ext-1.nina.no/dms/maps/main/maps.json
+              VITE_HIDE_EDIT_BUTTON=true
           - name: internal
-            config_branch: main
-            suffix: ""
-            edit: "false"
+            image_suffix: ""
+            tag_suffix: ""
+            target: ""
+            build_args: |
+              VITE_DEFAULT_CONFIGURATION=https://s3-ext-1.nina.no/dms/maps/main/maps.json
+              VITE_HIDE_EDIT_BUTTON=false
+          - name: server
+            image_suffix: "-server"
+            tag_suffix: ""
+            target: "server"
+            build_args: ""
 
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
         with:
           persist-credentials: false
+      - name: Setup Buildx
+        uses: docker/setup-buildx-action@v3
       - name: Login to registry
         if: github.event_name != 'pull_request'
         uses: docker/login-action@v2
@@ -44,17 +57,19 @@ jobs:
         id: meta
         uses: docker/metadata-action@v4
         with:
-          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}${{ matrix.variant.image_suffix }}
           tags: |
-            type=ref,event=branch,suffix=${{ matrix.variant.suffix }}
-            type=sha,suffix=${{ matrix.variant.suffix }}
+            type=ref,event=branch,suffix=${{ matrix.variant.tag_suffix }}
+            type=sha,suffix=${{ matrix.variant.tag_suffix }}
+            type=semver,pattern={{version}},suffix=${{ matrix.variant.tag_suffix }}
       - name: Build and push Docker image
         uses: docker/build-push-action@v3
         with:
           context: .
-          push: ${{ github.event_name != 'pull_request' }}
+          target: ${{ matrix.variant.target }}
+          push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
-          build-args: |
-            VITE_DEFAULT_CONFIGURATION=https://s3-ext-1.nina.no/dms/maps/${{ matrix.variant.config_branch }}/maps.json
-            VITE_HIDE_EDIT_BUTTON=${{ matrix.variant.edit }}
+          build-args: ${{ matrix.variant.build_args }}
+          cache-from: type=gha,scope=${{ matrix.variant.name }}
+          cache-to: type=gha,mode=max,scope=${{ matrix.variant.name }}

Dockerfile

@@ -29,7 +29,23 @@ EXPOSE 5173
 CMD ["pnpm", "run", "dev"]
 
 
-FROM nginx:stable-alpine-slim
+FROM nginx:stable-alpine-slim AS nginx
 
 COPY nginx/default.conf.template /etc/nginx/templates/
 COPY --from=build /app/dist /var/www/
+
+
+FROM denoland/deno:2 AS server
+
+WORKDIR /app
+
+COPY deno.json package.json ./
+COPY src/server.ts src/map-config.ts src/
+COPY src/schemas/ src/schemas/
+
+RUN deno cache --sloppy-imports src/server.ts
+
+EXPOSE 8080
+ENV PORT=8080
+
+CMD ["run", "--sloppy-imports", "--allow-net", "--allow-env=PORT", "src/server.ts"]

package.json

@@ -13,6 +13,7 @@
     "generate-schema": "deno run --sloppy-imports src/cli.ts schema > schemas/map-config.schema.json",
     "cli": "deno run --sloppy-imports src/cli.ts",
     "cli:build": "deno compile --sloppy-imports --output dist/nina-map-cli src/cli.ts",
+    "server": "deno run --sloppy-imports --allow-net --allow-env=PORT src/server.ts",
     "prepare": "husky"
   },
   "dependencies": {

src/cli.ts

@@ -3,7 +3,7 @@
 import { Command } from 'jsr:@cliffy/command@^1';
 import * as z from 'zod';
 import pkg from '../package.json' with { type: 'json' };
-import { MapConfigSchema } from './schemas';
+import { buildSchema, validateConfig } from './map-config.ts';
 
 await new Command()
   .name('nina-maps')
@@ -32,7 +32,7 @@ await new Command()
           Deno.exit(1);
         }
 
-        const result = MapConfigSchema.safeParse(data);
+        const result = validateConfig(data);
 
         if (result.success) {
           console.log('Valid map configuration.');
@@ -46,14 +46,7 @@ await new Command()
   .command(
     'schema',
     new Command().description('Print the JSON Schema for a nina-maps configuration.').action(() => {
-      const schema = {
-        $schema: 'https://json-schema.org/draft/2020-12/schema',
-        title: 'Nina Maps Configuration',
-        description: 'Configuration schema for a nina-maps map.',
-        version: pkg.version,
-        ...z.toJSONSchema(MapConfigSchema),
-      };
-      console.log(JSON.stringify(schema, null, 2));
+      console.log(JSON.stringify(buildSchema(), null, 2));
     }),
   )
   .parse(Deno.args);

src/map-config.ts

@@ -0,0 +1,82 @@
+import * as z from 'zod';
+import pkg from '../package.json' with { type: 'json' };
+import { MapConfigSchema } from './schemas';
+
+export { MapConfigSchema };
+
+export function buildSchema() {
+  return {
+    $schema: 'https://json-schema.org/draft/2020-12/schema',
+    title: 'Nina Maps Configuration',
+    description: 'Configuration schema for a nina-maps map.',
+    version: pkg.version,
+    ...z.toJSONSchema(MapConfigSchema),
+  };
+}
+
+export function validateConfig(data: unknown) {
+  return MapConfigSchema.safeParse(data);
+}
+
+export function buildOpenApiSpec() {
+  const mapConfigSchema = z.toJSONSchema(MapConfigSchema, { target: 'openapi3.1' });
+
+  return {
+    openapi: '3.1.0',
+    info: {
+      title: 'Nina Maps API',
+      description: 'Validation API for nina-maps configurations.',
+      version: pkg.version,
+    },
+    paths: {
+      '/api/validate': {
+        post: {
+          summary: 'Validate a map configuration',
+          requestBody: {
+            required: true,
+            content: { 'application/json': { schema: mapConfigSchema } },
+          },
+          responses: {
+            '200': {
+              description: 'Configuration is valid',
+              content: {
+                'application/json': { schema: { type: 'object', properties: { valid: { type: 'boolean' } } } },
+              },
+            },
+            '400': {
+              description: 'Invalid JSON body',
+              content: {
+                'application/json': { schema: { type: 'object', properties: { error: { type: 'string' } } } },
+              },
+            },
+            '422': {
+              description: 'Validation failed',
+              content: {
+                'application/json': {
+                  schema: {
+                    type: 'object',
+                    properties: {
+                      valid: { type: 'boolean' },
+                      errors: { type: 'object' },
+                    },
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+      '/api/schema': {
+        get: {
+          summary: 'Get the JSON Schema for a map configuration',
+          responses: {
+            '200': {
+              description: 'JSON Schema object',
+              content: { 'application/json': { schema: { type: 'object' } } },
+            },
+          },
+        },
+      },
+    },
+  };
+}

src/server.ts

@@ -0,0 +1,55 @@
+#!/usr/bin/env -S deno run --allow-net --allow-env=PORT
+/// <reference lib="deno.ns" />
+import * as z from 'zod';
+import { buildOpenApiSpec, buildSchema, validateConfig } from './map-config.ts';
+
+const port = Number(Deno.env.get('PORT') ?? 8080);
+
+const SWAGGER_UI_HTML = `<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8" />
+  <title>Nina Maps API</title>
+  <link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist/swagger-ui.css" />
+</head>
+<body>
+  <div id="swagger-ui"></div>
+  <script src="https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"></script>
+  <script>
+    SwaggerUIBundle({ url: '/api/openapi.json', dom_id: '#swagger-ui', deepLinking: true });
+  </script>
+</body>
+</html>`;
+
+Deno.serve({ port }, async req => {
+  const { pathname } = new URL(req.url);
+
+  if (pathname === '/api/schema' && req.method === 'GET') {
+    return Response.json(buildSchema());
+  }
+
+  if (pathname === '/api/openapi.json' && req.method === 'GET') {
+    return Response.json(buildOpenApiSpec());
+  }
+
+  if (pathname === '/api/docs' && req.method === 'GET') {
+    return new Response(SWAGGER_UI_HTML, { headers: { 'content-type': 'text/html; charset=utf-8' } });
+  }
+
+  if (pathname === '/api/validate' && req.method === 'POST') {
+    let data: unknown;
+    try {
+      data = await req.json();
+    } catch {
+      return Response.json({ error: 'Invalid JSON body' }, { status: 400 });
+    }
+
+    const result = validateConfig(data);
+    if (result.success) {
+      return Response.json({ valid: true });
+    }
+    return Response.json({ valid: false, errors: z.treeifyError(result.error) }, { status: 422 });
+  }
+
+  return new Response('Not Found', { status: 404 });
+});