@geode/opengeodeweb-front 10.35.0 → 10.36.0-rc.2

package/server/api/cloud/extensions/schemas/run.json

@@ -3,9 +3,48 @@
   "methods": ["POST"],
   "type": "object",
   "properties": {
-    "projectFolderPath": { "type": "string" },
-    "projectName": { "type": "string" }
+    "projectFolderPath": {
+      "type": "string"
+    },
+    "projectName": {
+      "type": "string"
+    }
   },
   "required": ["projectFolderPath", "projectName"],
-  "additionalProperties": false
+  "additionalProperties": false,
+  "response": {
+    "type": "object",
+    "properties": {
+      "statusCode": {
+        "type": "integer"
+      },
+      "extensionsArray": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string"
+            },
+            "name": {
+              "type": "string"
+            },
+            "version": {
+              "type": "string"
+            },
+            "frontendContent": {
+              "type": "string"
+            },
+            "port": {
+              "type": "integer"
+            }
+          },
+          "required": ["id", "name", "version", "frontendContent", "port"],
+          "additionalProperties": false
+        }
+      }
+    },
+    "required": ["statusCode", "extensionsArray"],
+    "additionalProperties": false
+  }
 }

package/server/api/local/app/kill.post.ts

@@ -2,11 +2,13 @@
 
 // Third party imports
 import { consola } from "consola";
-import { defineEventHandler } from "h3";
+
+import { defineTypedEventHandler } from "@geode/opengeodeweb-front/server/utils/typed_handler.ts";
+import schemas from "@geode/opengeodeweb-front/opengeodeweb_front_typed_schemas.js";
 
 // Local imports
 
-export default defineEventHandler(() => {
+export default defineTypedEventHandler(schemas.api.local.app.kill, () => {
   consola.info("Killing node server process");
   // oxlint-disable-next-line no-process-exit
   process.exit();

package/server/api/local/app/project_folder_path.post.ts

@@ -1,8 +1,6 @@
 // Node imports
 
 // Third party imports
-import { type H3Event, createError, defineEventHandler, readBody } from "h3";
-import { consola } from "consola";
 
 // Local imports
 import {
@@ -10,25 +8,11 @@ import {
   generateProjectFolderPath,
 } from "@geode/opengeodeweb-front/server/utils/path.ts";
 
-interface ProjectFolderPathBody {
-  PROJECT: string;
-}
+import { defineTypedEventHandler } from "@geode/opengeodeweb-front/server/utils/typed_handler.ts";
+import schemas from "@geode/opengeodeweb-front/opengeodeweb_front_typed_schemas.js";
 
-export default defineEventHandler(async (event: H3Event) => {
-  try {
-    const { PROJECT } = await readBody<ProjectFolderPathBody>(event);
-    const projectFolderPath = generateProjectFolderPath(PROJECT);
-    createPath(projectFolderPath);
-
-    return {
-      statusCode: 200,
-      projectFolderPath,
-    };
-  } catch (error) {
-    consola.error(error);
-    throw createError({
-      statusCode: 500,
-      statusMessage: error instanceof Error ? error.message : String(error),
-    });
-  }
+export default defineTypedEventHandler(schemas.api.local.app.project_folder_path, ({ PROJECT }) => {
+  const projectFolderPath = generateProjectFolderPath(PROJECT);
+  createPath(projectFolderPath);
+  return { statusCode: 200, projectFolderPath };
 });

package/server/api/local/app/run_back.post.ts

@@ -1,8 +1,6 @@
 // Node imports
 
 // Third party imports
-import { type H3Event, createError, defineEventHandler, readBody } from "h3";
-import { consola } from "consola";
 
 // Local imports
 import {
@@ -10,31 +8,18 @@ import {
   runBack,
 } from "@geode/opengeodeweb-front/server/utils/microservices.ts";
 
-interface RunBackBody {
-  COMMAND_BACK: string;
-  NUXT_ROOT_PATH: string;
-  args: { projectFolderPath: string; [key: string]: unknown };
-}
+import { defineTypedEventHandler } from "@geode/opengeodeweb-front/server/utils/typed_handler.ts";
+import schemas from "@geode/opengeodeweb-front/opengeodeweb_front_typed_schemas.js";
 
-export default defineEventHandler(async (event: H3Event) => {
-  try {
-    const { COMMAND_BACK, NUXT_ROOT_PATH, args } = await readBody<RunBackBody>(event);
+export default defineTypedEventHandler(
+  schemas.api.local.app.run_back,
+  async ({ COMMAND_BACK, NUXT_ROOT_PATH, args }) => {
     const port = await runBack(COMMAND_BACK, NUXT_ROOT_PATH, args);
     addMicroserviceMetadatas(args.projectFolderPath, {
       type: "back",
       name: COMMAND_BACK,
       port,
     });
-
-    return {
-      statusCode: 200,
-      port,
-    };
-  } catch (error) {
-    consola.error(error);
-    throw createError({
-      statusCode: 500,
-      statusMessage: error instanceof Error ? error.message : String(error),
-    });
-  }
-});
+    return { statusCode: 200, port };
+  },
+);

package/server/api/local/app/run_viewer.post.ts

@@ -1,8 +1,6 @@
 // Node imports
 
 // Third party imports
-import { type H3Event, createError, defineEventHandler, readBody } from "h3";
-import { consola } from "consola";
 
 // Local imports
 import {
@@ -10,31 +8,18 @@ import {
   runViewer,
 } from "@geode/opengeodeweb-front/server/utils/microservices.ts";
 
-interface RunViewerBody {
-  COMMAND_VIEWER: string;
-  NUXT_ROOT_PATH: string;
-  args: { projectFolderPath: string; [key: string]: unknown };
-}
+import { defineTypedEventHandler } from "@geode/opengeodeweb-front/server/utils/typed_handler.ts";
+import schemas from "@geode/opengeodeweb-front/opengeodeweb_front_typed_schemas.js";
 
-export default defineEventHandler(async (event: H3Event) => {
-  try {
-    const { COMMAND_VIEWER, NUXT_ROOT_PATH, args } = await readBody<RunViewerBody>(event);
+export default defineTypedEventHandler(
+  schemas.api.local.app.run_viewer,
+  async ({ COMMAND_VIEWER, NUXT_ROOT_PATH, args }) => {
     const port = await runViewer(COMMAND_VIEWER, NUXT_ROOT_PATH, args);
     addMicroserviceMetadatas(args.projectFolderPath, {
       type: "viewer",
       name: COMMAND_VIEWER,
       port,
     });
-
-    return {
-      statusCode: 200,
-      port,
-    };
-  } catch (error) {
-    consola.error(error);
-    throw createError({
-      statusCode: 500,
-      statusMessage: error instanceof Error ? error.message : String(error),
-    });
-  }
-});
+    return { statusCode: 200, port };
+  },
+);

package/server/api/local/app/schemas/kill.json

@@ -4,5 +4,11 @@
   "type": "object",
   "properties": {},
   "required": [],
-  "additionalProperties": false
+  "additionalProperties": false,
+  "response": {
+    "type": "object",
+    "properties": {},
+    "required": [],
+    "additionalProperties": false
+  }
 }

package/server/api/local/app/schemas/project_folder_path.json

@@ -2,7 +2,24 @@
   "route": "/project_folder_path",
   "methods": ["POST"],
   "type": "object",
-  "properties": { "PROJECT": { "type": "string" } },
+  "properties": {
+    "PROJECT": {
+      "type": "string"
+    }
+  },
   "required": ["PROJECT"],
-  "additionalProperties": true
+  "additionalProperties": true,
+  "response": {
+    "type": "object",
+    "properties": {
+      "statusCode": {
+        "type": "integer"
+      },
+      "projectFolderPath": {
+        "type": "string"
+      }
+    },
+    "required": ["statusCode", "projectFolderPath"],
+    "additionalProperties": false
+  }
 }

package/server/api/local/app/schemas/run_back.json

@@ -3,9 +3,36 @@
   "methods": ["POST"],
   "type": "object",
   "properties": {
-    "COMMAND_BACK": { "type": "string" },
-    "NUXT_ROOT_PATH": { "type": "string" }
+    "COMMAND_BACK": {
+      "type": "string"
+    },
+    "NUXT_ROOT_PATH": {
+      "type": "string"
+    },
+    "args": {
+      "type": "object",
+      "properties": {
+        "projectFolderPath": {
+          "type": "string"
+        }
+      },
+      "required": ["projectFolderPath"],
+      "additionalProperties": true
+    }
   },
-  "required": ["COMMAND_BACK", "NUXT_ROOT_PATH"],
-  "additionalProperties": true
+  "required": ["COMMAND_BACK", "NUXT_ROOT_PATH", "args"],
+  "additionalProperties": true,
+  "response": {
+    "type": "object",
+    "properties": {
+      "statusCode": {
+        "type": "integer"
+      },
+      "port": {
+        "type": "integer"
+      }
+    },
+    "required": ["statusCode", "port"],
+    "additionalProperties": false
+  }
 }

package/server/api/local/app/schemas/run_viewer.json

@@ -3,9 +3,36 @@
   "methods": ["POST"],
   "type": "object",
   "properties": {
-    "COMMAND_VIEWER": { "type": "string" },
-    "NUXT_ROOT_PATH": { "type": "string" }
+    "COMMAND_VIEWER": {
+      "type": "string"
+    },
+    "NUXT_ROOT_PATH": {
+      "type": "string"
+    },
+    "args": {
+      "type": "object",
+      "properties": {
+        "projectFolderPath": {
+          "type": "string"
+        }
+      },
+      "required": ["projectFolderPath"],
+      "additionalProperties": true
+    }
   },
-  "required": ["COMMAND_VIEWER", "NUXT_ROOT_PATH"],
-  "additionalProperties": true
+  "required": ["COMMAND_VIEWER", "NUXT_ROOT_PATH", "args"],
+  "additionalProperties": true,
+  "response": {
+    "type": "object",
+    "properties": {
+      "statusCode": {
+        "type": "integer"
+      },
+      "port": {
+        "type": "integer"
+      }
+    },
+    "required": ["statusCode", "port"],
+    "additionalProperties": false
+  }
 }

package/server/api/local/extensions/kill.post.ts

@@ -1,7 +1,6 @@
 // Node imports
 
 // Third party imports
-import { type H3Event, createError, defineEventHandler, readBody } from "h3";
 import { consola } from "consola";
 
 // Local imports
@@ -14,17 +13,12 @@ import {
 import { extensionFolderPath } from "@geode/opengeodeweb-front/server/utils/path.ts";
 import { removeExtensionFromConf } from "@geode/opengeodeweb-front/server/utils/app_config.ts";
 
-interface KillExtensionBody {
-  projectFolderPath: string;
-  projectName: string;
-  extensionId: string;
-}
-
-export default defineEventHandler(async (event: H3Event) => {
-  try {
-    const body = await readBody<KillExtensionBody>(event);
-    const { projectFolderPath, projectName, extensionId } = body;
+import { defineTypedEventHandler } from "@geode/opengeodeweb-front/server/utils/typed_handler.ts";
+import schemas from "@geode/opengeodeweb-front/opengeodeweb_front_typed_schemas.js";
 
+export default defineTypedEventHandler(
+  schemas.api.local.extensions.kill,
+  async ({ projectFolderPath, projectName, extensionId }) => {
     consola.debug({ projectFolderPath, projectName, extensionId });
 
     const microservices = projectMicroservices(projectFolderPath);
@@ -37,15 +31,6 @@ export default defineEventHandler(async (event: H3Event) => {
     await killMicroservice(microservice);
     await deleteFolderRecursive(extensionFolderPath(projectFolderPath, extensionId));
 
-    return {
-      statusCode: 200,
-    };
-  } catch (error) {
-    consola.error("Error killing extension:", error);
-    throw createError({
-      statusCode: 500,
-
-      statusMessage: error instanceof Error ? error.message : String(error),
-    });
-  }
-});
+    return { statusCode: 200 };
+  },
+);

package/server/api/local/extensions/run.post.ts

@@ -2,8 +2,6 @@
 import fs from "node:fs";
 
 // Third party imports
-import { type H3Event, createError, defineEventHandler, readBody } from "h3";
-import { consola } from "consola";
 
 // Local imports
 import {
@@ -21,14 +19,12 @@ import {
 import { extensionsConf } from "@geode/opengeodeweb-front/server/utils/app_config.ts";
 import { unzipFile } from "@geode/opengeodeweb-front/server/utils/server.ts";
 
-interface RunExtensionsBody {
-  projectFolderPath: string;
-  projectName: string;
-}
+import { defineTypedEventHandler } from "@geode/opengeodeweb-front/server/utils/typed_handler.ts";
+import schemas from "@geode/opengeodeweb-front/opengeodeweb_front_typed_schemas.js";
 
-export default defineEventHandler(async (event: H3Event) => {
-  try {
-    const { projectFolderPath, projectName } = await readBody<RunExtensionsBody>(event);
+export default defineTypedEventHandler(
+  schemas.api.local.extensions.run,
+  async ({ projectFolderPath, projectName }) => {
     const extensionsConfig = extensionsConf(projectName);
     const extensionsArray = await Promise.all(
       Object.entries(extensionsConfig).map(async ([extensionId, { path: extensionPath }]) => {
@@ -62,16 +58,6 @@ export default defineEventHandler(async (event: H3Event) => {
       }),
     );
 
-    return {
-      statusCode: 200,
-      extensionsArray,
-    };
-  } catch (error) {
-    consola.error("Error running extensions:", error);
-    throw createError({
-      statusCode: 500,
-
-      statusMessage: error instanceof Error ? error.message : String(error),
-    });
-  }
-});
+    return { statusCode: 200, extensionsArray };
+  },
+);

package/server/api/local/extensions/schemas/kill.json

@@ -3,10 +3,26 @@
   "methods": ["POST"],
   "type": "object",
   "properties": {
-    "extensionId": { "type": "string" },
-    "projectFolderPath": { "type": "string" },
-    "projectName": { "type": "string" }
+    "extensionId": {
+      "type": "string"
+    },
+    "projectFolderPath": {
+      "type": "string"
+    },
+    "projectName": {
+      "type": "string"
+    }
   },
   "required": ["extensionId", "projectFolderPath", "projectName"],
-  "additionalProperties": false
+  "additionalProperties": false,
+  "response": {
+    "type": "object",
+    "properties": {
+      "statusCode": {
+        "type": "integer"
+      }
+    },
+    "required": ["statusCode"],
+    "additionalProperties": false
+  }
 }

package/server/api/local/extensions/schemas/run.json

@@ -3,9 +3,48 @@
   "methods": ["POST"],
   "type": "object",
   "properties": {
-    "projectFolderPath": { "type": "string" },
-    "projectName": { "type": "string" }
+    "projectFolderPath": {
+      "type": "string"
+    },
+    "projectName": {
+      "type": "string"
+    }
   },
   "required": ["projectFolderPath", "projectName"],
-  "additionalProperties": false
+  "additionalProperties": false,
+  "response": {
+    "type": "object",
+    "properties": {
+      "statusCode": {
+        "type": "integer"
+      },
+      "extensionsArray": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string"
+            },
+            "name": {
+              "type": "string"
+            },
+            "version": {
+              "type": "string"
+            },
+            "frontendContent": {
+              "type": "string"
+            },
+            "port": {
+              "type": "integer"
+            }
+          },
+          "required": ["id", "name", "version", "frontendContent", "port"],
+          "additionalProperties": false
+        }
+      }
+    },
+    "required": ["statusCode", "extensionsArray"],
+    "additionalProperties": false
+  }
 }

package/server/api/local/extensions/schemas/upload.json

@@ -8,5 +8,15 @@
       "minLength": 1
     }
   },
-  "additionalProperties": false
+  "additionalProperties": false,
+  "response": {
+    "type": "object",
+    "properties": {
+      "statusCode": {
+        "type": "integer"
+      }
+    },
+    "required": ["statusCode"],
+    "additionalProperties": false
+  }
 }

package/server/api/local/extensions/upload.put.ts

@@ -4,7 +4,7 @@ import fs from "node:fs";
 import { pipeline } from "node:stream/promises";
 
 // Third party imports
-import { type H3Event, createError, defineEventHandler, getQuery, getRequestWebStream } from "h3";
+import { type H3Event, createError, getQuery, getRequestWebStream } from "h3";
 
 // Local imports
 import {
@@ -14,6 +14,11 @@ import {
 import { BYTES_PER_KIBIBYTE } from "@ogw_shared/utils/file.js";
 import { toNodeWebStream } from "@geode/opengeodeweb-front/server/utils/stream.ts";
 
+import schemas, {
+  type LocalExtensionsUploadResponse,
+} from "@geode/opengeodeweb-front/opengeodeweb_front_typed_schemas.js";
+import { defineRawEventHandler } from "@geode/opengeodeweb-front/server/utils/typed_handler.ts";
+
 const CODE_200 = 200;
 const CODE_201 = 201;
 const MAX_FILE_MEGABYTES = 500;
@@ -36,36 +41,39 @@ function requiredQueryInt(event: H3Event, key: string): number {
 }
 
 // The file is sent as a raw (non-multipart) body, split into sequential chunks the client uploads in order (see OpenGeodeWeb-Front's upload_file.ts and OpenGeodeWeb-Back's upload_file route, which use the same protocol). Each chunk is appended to a `.part` file; the last one triggers the existing zip-metadata registration.
-export default defineEventHandler(async (event: H3Event) => {
-  const projectName = requiredQueryString(event, "projectName");
-  const filename = requiredQueryString(event, "filename");
-  const totalChunks = requiredQueryInt(event, "total_chunks");
-  const chunkIndex = requiredQueryInt(event, "chunk_index");
-  if (chunkIndex >= totalChunks) {
-    throw createError({ statusCode: 400, message: "chunk_index must be less than total_chunks" });
-  }
+export default defineRawEventHandler(
+  schemas.api.local.extensions.upload,
+  async (event: H3Event): Promise<LocalExtensionsUploadResponse> => {
+    const projectName = requiredQueryString(event, "projectName");
+    const filename = requiredQueryString(event, "filename");
+    const totalChunks = requiredQueryInt(event, "total_chunks");
+    const chunkIndex = requiredQueryInt(event, "chunk_index");
+    if (chunkIndex >= totalChunks) {
+      throw createError({ statusCode: 400, message: "chunk_index must be less than total_chunks" });
+    }
 
-  const webStream = getRequestWebStream(event);
-  if (!webStream) {
-    throw createError({ statusCode: 400, message: "No request body received" });
-  }
+    const webStream = getRequestWebStream(event);
+    if (!webStream) {
+      throw createError({ statusCode: 400, message: "No request body received" });
+    }
 
-  const targetPath = targetExtensionFilePath(projectName, filename);
-  const partPath = `${targetPath}.part`;
-  const writeStream = fs.createWriteStream(partPath, { flags: chunkIndex === 0 ? "w" : "a" });
-  await pipeline(Readable.fromWeb(toNodeWebStream(webStream)), writeStream);
+    const targetPath = targetExtensionFilePath(projectName, filename);
+    const partPath = `${targetPath}.part`;
+    const writeStream = fs.createWriteStream(partPath, { flags: chunkIndex === 0 ? "w" : "a" });
+    await pipeline(Readable.fromWeb(toNodeWebStream(webStream)), writeStream);
 
-  const { size } = await fs.promises.stat(partPath);
-  if (size > FILE_SIZE_LIMIT) {
-    await fs.promises.unlink(partPath);
-    throw createError({ statusCode: 400, message: "File too large" });
-  }
+    const { size } = await fs.promises.stat(partPath);
+    if (size > FILE_SIZE_LIMIT) {
+      await fs.promises.unlink(partPath);
+      throw createError({ statusCode: 400, message: "File too large" });
+    }
 
-  if (chunkIndex < totalChunks - 1) {
-    return { statusCode: CODE_200 };
-  }
+    if (chunkIndex < totalChunks - 1) {
+      return { statusCode: CODE_200 };
+    }
 
-  await fs.promises.rename(partPath, targetPath);
-  await registerExtensionFile(projectName, targetPath);
-  return { statusCode: CODE_201 };
-});
+    await fs.promises.rename(partPath, targetPath);
+    await registerExtensionFile(projectName, targetPath);
+    return { statusCode: CODE_201 };
+  },
+);

package/server/api/microservice/app/get_is_app_ready.get.ts

@@ -1,20 +1,14 @@
 // Third party imports
-import { createError, defineEventHandler } from "h3";
 import { consola } from "consola";
 
 // Local imports
 import { getIsAppReady } from "@geode/opengeodeweb-front/server/utils/server_config.ts";
 
-export default defineEventHandler(() => {
-  try {
-    const isReady = getIsAppReady();
-    consola.info(`IS_APP_READY is ${isReady}`);
-    return { statusCode: 200, isReady };
-  } catch (error) {
-    consola.error(error);
-    throw createError({
-      statusCode: 500,
-      statusMessage: error instanceof Error ? error.message : String(error),
-    });
-  }
+import { defineTypedEventHandler } from "@geode/opengeodeweb-front/server/utils/typed_handler.ts";
+import schemas from "@geode/opengeodeweb-front/opengeodeweb_front_typed_schemas.js";
+
+export default defineTypedEventHandler(schemas.api.microservice.app.get_is_app_ready, () => {
+  const isReady = getIsAppReady();
+  consola.info(`IS_APP_READY is ${isReady}`);
+  return { statusCode: 200, isReady };
 });