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

package/opengeodeweb_front_schemas.json

@@ -16,7 +16,42 @@
             }
           },
           "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
+          }
         }
       }
     },
@@ -33,10 +68,33 @@
             },
             "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
+          }
         },
         "run_back": {
           "$id": "api/local/app/run_back",
@@ -49,10 +107,33 @@
             },
             "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
+          }
         },
         "project_folder_path": {
           "$id": "api/local/app/project_folder_path",
@@ -65,7 +146,20 @@
             }
           },
           "required": ["PROJECT"],
-          "additionalProperties": true
+          "additionalProperties": true,
+          "response": {
+            "type": "object",
+            "properties": {
+              "statusCode": {
+                "type": "integer"
+              },
+              "projectFolderPath": {
+                "type": "string"
+              }
+            },
+            "required": ["statusCode", "projectFolderPath"],
+            "additionalProperties": false
+          }
         },
         "kill": {
           "$id": "api/local/app/kill",
@@ -74,7 +168,13 @@
           "type": "object",
           "properties": {},
           "required": [],
-          "additionalProperties": false
+          "additionalProperties": false,
+          "response": {
+            "type": "object",
+            "properties": {},
+            "required": [],
+            "additionalProperties": false
+          }
         }
       },
       "extensions": {
@@ -89,7 +189,17 @@
               "minLength": 1
             }
           },
-          "additionalProperties": false
+          "additionalProperties": false,
+          "response": {
+            "type": "object",
+            "properties": {
+              "statusCode": {
+                "type": "integer"
+              }
+            },
+            "required": ["statusCode"],
+            "additionalProperties": false
+          }
         },
         "run": {
           "$id": "api/local/extensions/run",
@@ -105,7 +215,42 @@
             }
           },
           "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
+          }
         },
         "kill": {
           "$id": "api/local/extensions/kill",
@@ -124,7 +269,17 @@
             }
           },
           "required": ["extensionId", "projectFolderPath", "projectName"],
-          "additionalProperties": false
+          "additionalProperties": false,
+          "response": {
+            "type": "object",
+            "properties": {
+              "statusCode": {
+                "type": "integer"
+              }
+            },
+            "required": ["statusCode"],
+            "additionalProperties": false
+          }
         }
       }
     },
@@ -141,7 +296,20 @@
             }
           },
           "required": ["baseUrl"],
-          "additionalProperties": false
+          "additionalProperties": false,
+          "response": {
+            "type": "object",
+            "properties": {
+              "statusCode": {
+                "type": "integer"
+              },
+              "baseUrl": {
+                "type": "string"
+              }
+            },
+            "required": ["statusCode", "baseUrl"],
+            "additionalProperties": false
+          }
         },
         "set_is_app_ready": {
           "$id": "api/microservice/app/set_is_app_ready",
@@ -154,7 +322,20 @@
             }
           },
           "required": ["isReady"],
-          "additionalProperties": false
+          "additionalProperties": false,
+          "response": {
+            "type": "object",
+            "properties": {
+              "statusCode": {
+                "type": "integer"
+              },
+              "isReady": {
+                "type": "boolean"
+              }
+            },
+            "required": ["statusCode", "isReady"],
+            "additionalProperties": false
+          }
         },
         "set_back_base_url": {
           "$id": "api/microservice/app/set_back_base_url",
@@ -167,7 +348,20 @@
             }
           },
           "required": ["baseUrl"],
-          "additionalProperties": false
+          "additionalProperties": false,
+          "response": {
+            "type": "object",
+            "properties": {
+              "statusCode": {
+                "type": "integer"
+              },
+              "baseUrl": {
+                "type": "string"
+              }
+            },
+            "required": ["statusCode", "baseUrl"],
+            "additionalProperties": false
+          }
         },
         "set_app_base_url": {
           "$id": "api/microservice/app/set_app_base_url",
@@ -180,7 +374,20 @@
             }
           },
           "required": ["baseUrl"],
-          "additionalProperties": false
+          "additionalProperties": false,
+          "response": {
+            "type": "object",
+            "properties": {
+              "statusCode": {
+                "type": "integer"
+              },
+              "baseUrl": {
+                "type": "string"
+              }
+            },
+            "required": ["statusCode", "baseUrl"],
+            "additionalProperties": false
+          }
         },
         "get_is_app_ready": {
           "$id": "api/microservice/app/get_is_app_ready",
@@ -189,7 +396,20 @@
           "type": "object",
           "properties": {},
           "required": [],
-          "additionalProperties": false
+          "additionalProperties": false,
+          "response": {
+            "type": "object",
+            "properties": {
+              "statusCode": {
+                "type": "integer"
+              },
+              "isReady": {
+                "type": "boolean"
+              }
+            },
+            "required": ["statusCode", "isReady"],
+            "additionalProperties": false
+          }
         }
       },
       "extensions": {
@@ -199,15 +419,28 @@
           "methods": ["POST"],
           "type": "object",
           "properties": {
-            "extension": {
+            "projectName": {
+              "type": "string"
+            },
+            "url": {
               "type": "string"
             },
-            "platform": {
+            "extensionFileName": {
               "type": "string"
             }
           },
-          "required": ["extension", "platform"],
-          "additionalProperties": false
+          "required": ["projectName", "url", "extensionFileName"],
+          "additionalProperties": false,
+          "response": {
+            "type": "object",
+            "properties": {
+              "statusCode": {
+                "type": "integer"
+              }
+            },
+            "required": ["statusCode"],
+            "additionalProperties": false
+          }
         }
       }
     }

package/opengeodeweb_front_typed_schemas.d.ts

@@ -0,0 +1,225 @@
+// Generated by opengeodeweb-microservice-generate, do not edit.
+import type json from "./opengeodeweb_front_schemas.json";
+
+export interface CloudExtensionsRunParams {
+  projectFolderPath: string;
+  projectName: string;
+}
+
+export interface CloudExtensionsRunResponse {
+  extensionsArray: CloudExtensionsRunResponseExtensionsArray[];
+  statusCode: number;
+}
+
+export interface CloudExtensionsRunResponseExtensionsArray {
+  frontendContent: string;
+  id: string;
+  name: string;
+  port: number;
+  version: string;
+}
+
+export interface LocalAppRunViewerParams {
+  args: LocalAppRunViewerParamsArgs;
+  COMMAND_VIEWER: string;
+  NUXT_ROOT_PATH: string;
+  [property: string]: any;
+}
+
+export interface LocalAppRunViewerParamsArgs {
+  projectFolderPath: string;
+  [property: string]: any;
+}
+
+export interface LocalAppRunViewerResponse {
+  port: number;
+  statusCode: number;
+}
+
+export interface LocalAppRunBackParams {
+  args: LocalAppRunBackParamsArgs;
+  COMMAND_BACK: string;
+  NUXT_ROOT_PATH: string;
+  [property: string]: any;
+}
+
+export interface LocalAppRunBackParamsArgs {
+  projectFolderPath: string;
+  [property: string]: any;
+}
+
+export interface LocalAppRunBackResponse {
+  port: number;
+  statusCode: number;
+}
+
+export interface LocalAppProjectFolderPathParams {
+  PROJECT: string;
+  [property: string]: any;
+}
+
+export interface LocalAppProjectFolderPathResponse {
+  projectFolderPath: string;
+  statusCode: number;
+}
+
+export interface LocalAppKillParams {}
+
+export interface LocalAppKillResponse {}
+
+export interface LocalExtensionsUploadParams {
+  filename?: string;
+}
+
+export interface LocalExtensionsUploadResponse {
+  statusCode: number;
+}
+
+export interface LocalExtensionsRunParams {
+  projectFolderPath: string;
+  projectName: string;
+}
+
+export interface LocalExtensionsRunResponse {
+  extensionsArray: LocalExtensionsRunResponseExtensionsArray[];
+  statusCode: number;
+}
+
+export interface LocalExtensionsRunResponseExtensionsArray {
+  frontendContent: string;
+  id: string;
+  name: string;
+  port: number;
+  version: string;
+}
+
+export interface LocalExtensionsKillParams {
+  extensionId: string;
+  projectFolderPath: string;
+  projectName: string;
+}
+
+export interface LocalExtensionsKillResponse {
+  statusCode: number;
+}
+
+export interface MicroserviceAppSetViewerBaseURLParams {
+  baseUrl: string;
+}
+
+export interface MicroserviceAppSetViewerBaseURLResponse {
+  baseUrl: string;
+  statusCode: number;
+}
+
+export interface MicroserviceAppSetIsAppReadyParams {
+  isReady: boolean;
+}
+
+export interface MicroserviceAppSetIsAppReadyResponse {
+  isReady: boolean;
+  statusCode: number;
+}
+
+export interface MicroserviceAppSetBackBaseURLParams {
+  baseUrl: string;
+}
+
+export interface MicroserviceAppSetBackBaseURLResponse {
+  baseUrl: string;
+  statusCode: number;
+}
+
+export interface MicroserviceAppSetAppBaseURLParams {
+  baseUrl: string;
+}
+
+export interface MicroserviceAppSetAppBaseURLResponse {
+  baseUrl: string;
+  statusCode: number;
+}
+
+export interface MicroserviceAppGetIsAppReadyParams {}
+
+export interface MicroserviceAppGetIsAppReadyResponse {
+  isReady: boolean;
+  statusCode: number;
+}
+
+export interface MicroserviceExtensionsDownloadParams {
+  extensionFileName: string;
+  projectName: string;
+  url: string;
+}
+
+export interface MicroserviceExtensionsDownloadResponse {
+  statusCode: number;
+}
+
+export interface ErrorResponse {
+  code: number;
+  description: string;
+  name: string;
+}
+
+// `__params` and `__response` only exist at type level, to infer request/response types from a schema.
+// A type alias (not an interface) keeps the implicit index signature of the JSON type it is intersected with.
+export type TypedSchema<Params, Response> = {
+  readonly __params?: Params;
+  readonly __response?: Response;
+};
+
+export interface Schemas {
+  readonly api: {
+    readonly cloud: {
+      readonly extensions: {
+        readonly run: (typeof json)["api"]["cloud"]["extensions"]["run"] &
+          TypedSchema<CloudExtensionsRunParams, CloudExtensionsRunResponse>;
+      };
+    };
+    readonly local: {
+      readonly app: {
+        readonly run_viewer: (typeof json)["api"]["local"]["app"]["run_viewer"] &
+          TypedSchema<LocalAppRunViewerParams, LocalAppRunViewerResponse>;
+        readonly run_back: (typeof json)["api"]["local"]["app"]["run_back"] &
+          TypedSchema<LocalAppRunBackParams, LocalAppRunBackResponse>;
+        readonly project_folder_path: (typeof json)["api"]["local"]["app"]["project_folder_path"] &
+          TypedSchema<LocalAppProjectFolderPathParams, LocalAppProjectFolderPathResponse>;
+        readonly kill: (typeof json)["api"]["local"]["app"]["kill"] &
+          TypedSchema<LocalAppKillParams, LocalAppKillResponse>;
+      };
+      readonly extensions: {
+        readonly upload: (typeof json)["api"]["local"]["extensions"]["upload"] &
+          TypedSchema<LocalExtensionsUploadParams, LocalExtensionsUploadResponse>;
+        readonly run: (typeof json)["api"]["local"]["extensions"]["run"] &
+          TypedSchema<LocalExtensionsRunParams, LocalExtensionsRunResponse>;
+        readonly kill: (typeof json)["api"]["local"]["extensions"]["kill"] &
+          TypedSchema<LocalExtensionsKillParams, LocalExtensionsKillResponse>;
+      };
+    };
+    readonly microservice: {
+      readonly app: {
+        readonly set_viewer_base_url: (typeof json)["api"]["microservice"]["app"]["set_viewer_base_url"] &
+          TypedSchema<
+            MicroserviceAppSetViewerBaseURLParams,
+            MicroserviceAppSetViewerBaseURLResponse
+          >;
+        readonly set_is_app_ready: (typeof json)["api"]["microservice"]["app"]["set_is_app_ready"] &
+          TypedSchema<MicroserviceAppSetIsAppReadyParams, MicroserviceAppSetIsAppReadyResponse>;
+        readonly set_back_base_url: (typeof json)["api"]["microservice"]["app"]["set_back_base_url"] &
+          TypedSchema<MicroserviceAppSetBackBaseURLParams, MicroserviceAppSetBackBaseURLResponse>;
+        readonly set_app_base_url: (typeof json)["api"]["microservice"]["app"]["set_app_base_url"] &
+          TypedSchema<MicroserviceAppSetAppBaseURLParams, MicroserviceAppSetAppBaseURLResponse>;
+        readonly get_is_app_ready: (typeof json)["api"]["microservice"]["app"]["get_is_app_ready"] &
+          TypedSchema<MicroserviceAppGetIsAppReadyParams, MicroserviceAppGetIsAppReadyResponse>;
+      };
+      readonly extensions: {
+        readonly download: (typeof json)["api"]["microservice"]["extensions"]["download"] &
+          TypedSchema<MicroserviceExtensionsDownloadParams, MicroserviceExtensionsDownloadResponse>;
+      };
+    };
+  };
+}
+
+declare const schemas: Schemas;
+export default schemas;

package/opengeodeweb_front_typed_schemas.js

@@ -0,0 +1,4 @@
+// Generated by opengeodeweb-microservice-generate, do not edit.
+import schemas from "./opengeodeweb_front_schemas.json" with { type: "json" };
+
+export default schemas;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geode/opengeodeweb-front",
-  "version": "10.35.0",
+  "version": "10.36.0-rc.2",
   "description": "OpenSource Vue/Nuxt/Pinia/Vuetify framework for web applications",
   "homepage": "https://github.com/Geode-solutions/OpenGeodeWeb-Front",
   "bugs": {
@@ -25,6 +25,8 @@
     "nuxt.config.ts",
     "opengeodeweb_front_schemas.json",
     "opengeodeweb_front_schemas.js",
+    "opengeodeweb_front_typed_schemas.js",
+    "opengeodeweb_front_typed_schemas.d.ts",
     "COPYLEFT",
     "LICENSE",
     "README.md"
@@ -53,7 +55,7 @@
     "build:back": "npx opengeodeweb-microservice-pyinstaller ../OpenGeodeWeb-Back",
     "build:viewer": "npx opengeodeweb-microservice-pyinstaller ../OpenGeodeWeb-Viewer",
     "build:microservices": "concurrently \"npm run build:back\" \"npm run build:viewer\"",
-    "json": "npx opengeodeweb-microservice-generate --startDir server/api --key route --separator / --prefix api",
+    "json": "npx opengeodeweb-microservice-generate --startDir server/api --key route --separator / --prefix api --requireResponse",
     "test": "npm run test:unit",
     "tests": "npm run prepare:types && vitest --config ./tests/vitest.config.ts",
     "test:unit": "npm run tests -- --project unit",
@@ -63,9 +65,9 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@geode/cloud-api": "latest",
-    "@geode/opengeodeweb-back": "latest",
-    "@geode/opengeodeweb-viewer": "latest",
+    "@geode/cloud-api": "next",
+    "@geode/opengeodeweb-back": "next",
+    "@geode/opengeodeweb-viewer": "next",
     "@kitware/vtk.js": "33.3.0",
     "@mdi/font": "7.4.47",
     "@pinia/nuxt": "1.0.1",

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

@@ -2,7 +2,6 @@
 import fs from "node:fs";
 
 // Third party imports
-import { type H3Event, createError, defineEventHandler, readBody } from "h3";
 import { consola } from "consola";
 
 // Local imports
@@ -21,15 +20,13 @@ 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 {
-    consola.debug("NITRO: runExtensions", event);
-    const { projectFolderPath, projectName } = await readBody<RunExtensionsBody>(event);
+export default defineTypedEventHandler(
+  schemas.api.cloud.extensions.run,
+  async ({ projectFolderPath, projectName }) => {
+    consola.debug("NITRO: runExtensions", { projectFolderPath, projectName });
     const extensionsConfig = extensionsConf(projectName);
     const extensionsArray = await Promise.all(
       Object.entries(extensionsConfig).map(async ([extensionId, { path: extensionPath }]) => {
@@ -63,15 +60,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 };
+  },
+);