@geode/opengeodeweb-front 10.35.0-rc.6 → 10.36.0-rc.1

package/.build/opengeodeweb_front_schemas.js

@@ -10,7 +10,36 @@ var api = {
 			"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
+		}
 	} } },
 	"local": {
 		"app": {
@@ -21,10 +50,29 @@ var api = {
 				"type": "object",
 				"properties": {
 					"COMMAND_VIEWER": { "type": "string" },
-					"NUXT_ROOT_PATH": { "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
+				}
 			},
 			"run_back": {
 				"$id": "api/local/app/run_back",
@@ -33,10 +81,29 @@ var api = {
 				"type": "object",
 				"properties": {
 					"COMMAND_BACK": { "type": "string" },
-					"NUXT_ROOT_PATH": { "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
+				}
 			},
 			"project_folder_path": {
 				"$id": "api/local/app/project_folder_path",
@@ -45,7 +112,16 @@ var api = {
 				"type": "object",
 				"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
+				}
 			},
 			"kill": {
 				"$id": "api/local/app/kill",
@@ -54,7 +130,13 @@ var api = {
 				"type": "object",
 				"properties": {},
 				"required": [],
-				"additionalProperties": false
+				"additionalProperties": false,
+				"response": {
+					"type": "object",
+					"properties": {},
+					"required": [],
+					"additionalProperties": false
+				}
 			}
 		},
 		"extensions": {
@@ -67,7 +149,13 @@ var api = {
 					"type": "string",
 					"minLength": 1
 				} },
-				"additionalProperties": false
+				"additionalProperties": false,
+				"response": {
+					"type": "object",
+					"properties": { "statusCode": { "type": "integer" } },
+					"required": ["statusCode"],
+					"additionalProperties": false
+				}
 			},
 			"run": {
 				"$id": "api/local/extensions/run",
@@ -79,7 +167,36 @@ var api = {
 					"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
+				}
 			},
 			"kill": {
 				"$id": "api/local/extensions/kill",
@@ -96,7 +213,13 @@ var api = {
 					"projectFolderPath",
 					"projectName"
 				],
-				"additionalProperties": false
+				"additionalProperties": false,
+				"response": {
+					"type": "object",
+					"properties": { "statusCode": { "type": "integer" } },
+					"required": ["statusCode"],
+					"additionalProperties": false
+				}
 			}
 		}
 	},
@@ -109,7 +232,16 @@ var api = {
 				"type": "object",
 				"properties": { "baseUrl": { "type": "string" } },
 				"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",
@@ -118,7 +250,16 @@ var api = {
 				"type": "object",
 				"properties": { "isReady": { "type": "boolean" } },
 				"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",
@@ -127,7 +268,16 @@ var api = {
 				"type": "object",
 				"properties": { "baseUrl": { "type": "string" } },
 				"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",
@@ -136,7 +286,16 @@ var api = {
 				"type": "object",
 				"properties": { "baseUrl": { "type": "string" } },
 				"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",
@@ -145,7 +304,16 @@ var api = {
 				"type": "object",
 				"properties": {},
 				"required": [],
-				"additionalProperties": false
+				"additionalProperties": false,
+				"response": {
+					"type": "object",
+					"properties": {
+						"statusCode": { "type": "integer" },
+						"isReady": { "type": "boolean" }
+					},
+					"required": ["statusCode", "isReady"],
+					"additionalProperties": false
+				}
 			}
 		},
 		"extensions": { "download": {
@@ -154,11 +322,22 @@ var api = {
 			"methods": ["POST"],
 			"type": "object",
 			"properties": {
-				"extension": { "type": "string" },
-				"platform": { "type": "string" }
+				"projectName": { "type": "string" },
+				"url": { "type": "string" },
+				"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/.build/server/utils/typed_handler.js

@@ -0,0 +1,63 @@
+import { validateSchema } from "../../shared/utils/validate_schema.js";
+import { consola } from "consola";
+import Ajv from "ajv";
+import { createError, defineEventHandler, getQuery, isError, readBody, setResponseStatus } from "h3";
+//#region server/utils/typed_handler.ts
+const BAD_REQUEST = 400;
+const INTERNAL_SERVER_ERROR = 500;
+function toErrorResponse(error) {
+	if (isError(error)) return {
+		code: error.statusCode,
+		name: error.statusMessage ?? "Error",
+		description: error.message
+	};
+	return {
+		code: INTERNAL_SERVER_ERROR,
+		name: "Internal Server Error",
+		description: error instanceof Error ? error.message : String(error)
+	};
+}
+function sendError(event, schema, error) {
+	consola.error(`[${schema.$id}]`, error);
+	const errorResponse = toErrorResponse(error);
+	setResponseStatus(event, errorResponse.code, errorResponse.name);
+	return errorResponse;
+}
+async function readParams(event) {
+	if (event.method === "GET" || event.method === "HEAD") return getQuery(event);
+	return await readBody(event) ?? {};
+}
+function checkResponse(schema, payload) {
+	if (process.env.NODE_ENV === "production" || schema.response === void 0) return;
+	const ajv = new Ajv();
+	if (!ajv.validate(schema.response, payload)) throw new Error(`${schema.$id} response does not match its schema: ${ajv.errorsText()}`);
+}
+function defineTypedEventHandler(schema, handler) {
+	return defineEventHandler(async (event) => {
+		try {
+			const params = await readParams(event);
+			const { valid, error } = validateSchema(schema, params);
+			if (!valid) throw createError({
+				statusCode: BAD_REQUEST,
+				statusMessage: "Bad Request",
+				message: error
+			});
+			const response = await handler(params, event);
+			checkResponse(schema, response);
+			return response;
+		} catch (error) {
+			return sendError(event, schema, error);
+		}
+	});
+}
+function defineRawEventHandler(schema, handler) {
+	return defineEventHandler(async (event) => {
+		try {
+			return await handler(event);
+		} catch (error) {
+			return sendError(event, schema, error);
+		}
+	});
+}
+//#endregion
+export { defineRawEventHandler, defineTypedEventHandler };

package/.build/shared/utils/validate_schema.js

@@ -6,7 +6,8 @@ function validateSchema(schema, body) {
 		"methods",
 		"route",
 		"max_retry",
-		"rpc"
+		"rpc",
+		"response"
 	]) ajv.addKeyword(keyword);
 	return {
 		valid: ajv.validate(schema, body),

package/app/components/CrsSelector.vue

@@ -1,5 +1,5 @@
 <script setup lang="ts">
-import schemas from "@geode/opengeodeweb-back/opengeodeweb_back_schemas.json";
+import schemas, { type CRSList } from "@geode/opengeodeweb-back/opengeodeweb_back_typed_schemas.js";
 import { useBackStore } from "@ogw_front/stores/back";
 
 const schema = schemas.opengeodeweb_back.geographic_coordinate_systems;
@@ -21,14 +21,14 @@ const { geodeObjectType, keyToUpdate } = defineProps<Props>();
 
 const search = ref<string>("");
 const data_table_loading = ref<boolean>(false);
-const crs_list = ref<Record<string, unknown>[]>([]);
+const crs_list = ref<CRSList[]>([]);
 const selected_crs = ref<unknown[]>([]);
 const toggle_loading = useToggle(data_table_loading);
 const backStore = useBackStore();
 
 function get_selected_crs(crs_code: unknown): unknown {
   for (const crs of crs_list.value) {
-    if (crs && crs["code"] === crs_code) {
+    if (crs.code === crs_code) {
       return crs;
     }
   }
@@ -49,8 +49,8 @@ async function get_crs_table(): void {
   await backStore.request(
     { schema, params },
     {
-      response_function: (response: unknown) => {
-        crs_list.value = (response as { crs_list: Record<string, unknown>[] }).crs_list;
+      response_function: (response) => {
+        crs_list.value = response.crs_list;
       },
     },
   );

package/app/components/ExtensionSelector.vue

@@ -1,5 +1,5 @@
 <script setup lang="ts">
-import schemas from "@geode/opengeodeweb-back/opengeodeweb_back_schemas.json";
+import schemas from "@geode/opengeodeweb-back/opengeodeweb_back_typed_schemas.js";
 
 import FetchingData from "@ogw_front/components/FetchingData.vue";
 import { useBackStore } from "@ogw_front/stores/back";
@@ -28,15 +28,11 @@ async function get_output_file_extensions(): Promise<void> {
   toggle_loading();
   geode_objects_and_output_extensions.value = {};
   const backStore = useBackStore();
-  const values: Record<string, OutputExtensions>[] = await Promise.all(
-    filenames.map(async (filename): Promise<Record<string, OutputExtensions>> => {
+  const values: Record<string, Record<string, boolean>>[] = await Promise.all(
+    filenames.map(async (filename): Promise<Record<string, Record<string, boolean>>> => {
       const params = { geode_object_type: geodeObjectType, filename };
       const response = await backStore.request({ schema, params });
-      return (
-        response as {
-          geode_objects_and_output_extensions: Record<string, OutputExtensions>;
-        }
-      ).geode_objects_and_output_extensions;
+      return response.geode_objects_and_output_extensions;
     }),
   );
   const all_keys = [...new Set(values.flatMap((value) => Object.keys(value)))];
@@ -49,10 +45,8 @@ async function get_output_file_extensions(): Promise<void> {
       if (!extensions) {
         continue;
       }
-      for (const extension of Object.keys(extensions)) {
-        final_object[key][extension] = {
-          is_saveable: extensions[extension].is_saveable,
-        };
+      for (const [extension, is_saveable] of Object.entries(extensions)) {
+        final_object[key][extension] = { is_saveable };
       }
     }
   }

package/app/components/FileSelector.vue

@@ -1,5 +1,5 @@
 <script setup lang="ts">
-import schemas from "@geode/opengeodeweb-back/opengeodeweb_back_schemas.json";
+import schemas from "@geode/opengeodeweb-back/opengeodeweb_back_typed_schemas.js";
 
 import FetchingData from "@ogw_front/components/FetchingData.vue";
 import FileUploader from "@ogw_front/components/FileUploader.vue";
@@ -55,9 +55,7 @@ function files_uploaded_event(value: unknown[]): void {
 async function get_allowed_files(): Promise<void> {
   toggle_loading();
   const backStore = useBackStore();
-  const response = (await backStore.request({ schema })) as {
-    extensions: string[];
-  };
+  const response = await backStore.request({ schema });
   accept.value = response.extensions.map((extension) => `.${extension}`).join(",");
   toggle_loading();
 }

package/app/components/MissingFilesSelector.vue

@@ -1,5 +1,5 @@
 <script setup lang="ts">
-import schemas from "@geode/opengeodeweb-back/opengeodeweb_back_schemas.json";
+import schemas from "@geode/opengeodeweb-back/opengeodeweb_back_typed_schemas.js";
 
 import FetchingData from "@ogw_front/components/FetchingData.vue";
 import FileUploader from "@ogw_front/components/FileUploader.vue";

package/app/components/ObjectSelector.vue

@@ -2,7 +2,7 @@
 import FetchingData from "@ogw_front/components/FetchingData.vue";
 import { geode_objects } from "@ogw_front/assets/geode_objects";
 import { resolveAllowedObjects } from "@ogw_shared/utils/response_handlers/load.js";
-import schemas from "@geode/opengeodeweb-back/opengeodeweb_back_schemas.json";
+import schemas from "@geode/opengeodeweb-back/opengeodeweb_back_typed_schemas.js";
 import { useBackStore } from "@ogw_front/stores/back";
 
 // Mirrors the (unexported) shape produced by shared/utils/response_handlers/load.ts.

package/app/components/ThresholdFilter.vue

@@ -7,7 +7,7 @@ import {
 import type { JsonRpcSchema } from "@ogw_shared/utils/types.js";
 import ToolPanel from "@ogw_front/components/ToolPanel.vue";
 import ViewerOptionsAttributeRangeSelector from "@ogw_front/components/Viewer/Options/AttributeRangeSelector.vue";
-import back_schemas from "@geode/opengeodeweb-back/opengeodeweb_back_schemas.json";
+import back_schemas from "@geode/opengeodeweb-back/opengeodeweb_back_typed_schemas.js";
 import { useBackStore } from "@ogw_front/stores/back";
 import { useDataStore } from "@ogw_front/stores/data";
 import { useDebounceFn } from "@vueuse/core";

package/app/components/Viewer/Generic/Model/BlocksOptions.vue

@@ -4,7 +4,7 @@ import OptionsSection from "@ogw_front/components/Viewer/Options/OptionsSection.
 import type { RGBAColor } from "@ogw_front/utils/default_styles/constants";
 import ViewerOptionsColoringTypeSelector from "@ogw_front/components/Viewer/Options/ColoringTypeSelector.vue";
 import VisibilitySwitch from "@ogw_front/components/Viewer/Options/VisibilitySwitch.vue";
-import back_schemas from "@geode/opengeodeweb-back/opengeodeweb_back_schemas.json";
+import back_schemas from "@geode/opengeodeweb-back/opengeodeweb_back_typed_schemas.js";
 import { useDataStyleStore } from "@ogw_front/stores/data_style";
 import { useHybridViewerStore } from "@ogw_front/stores/hybrid_viewer";
 

package/app/components/Viewer/Generic/Model/CornersOptions.vue

@@ -4,7 +4,7 @@ import OptionsSection from "@ogw_front/components/Viewer/Options/OptionsSection.
 import type { RGBAColor } from "@ogw_front/utils/default_styles/constants";
 import ViewerOptionsColoringTypeSelector from "@ogw_front/components/Viewer/Options/ColoringTypeSelector.vue";
 import VisibilitySwitch from "@ogw_front/components/Viewer/Options/VisibilitySwitch.vue";
-import back_schemas from "@geode/opengeodeweb-back/opengeodeweb_back_schemas.json";
+import back_schemas from "@geode/opengeodeweb-back/opengeodeweb_back_typed_schemas.js";
 import { useDataStyleStore } from "@ogw_front/stores/data_style";
 import { useHybridViewerStore } from "@ogw_front/stores/hybrid_viewer";
 

package/app/components/Viewer/Generic/Model/LinesOptions.vue

@@ -4,7 +4,7 @@ import OptionsSection from "@ogw_front/components/Viewer/Options/OptionsSection.
 import type { RGBAColor } from "@ogw_front/utils/default_styles/constants";
 import ViewerOptionsColoringTypeSelector from "@ogw_front/components/Viewer/Options/ColoringTypeSelector.vue";
 import VisibilitySwitch from "@ogw_front/components/Viewer/Options/VisibilitySwitch.vue";
-import back_schemas from "@geode/opengeodeweb-back/opengeodeweb_back_schemas.json";
+import back_schemas from "@geode/opengeodeweb-back/opengeodeweb_back_typed_schemas.js";
 import { useDataStyleStore } from "@ogw_front/stores/data_style";
 import { useHybridViewerStore } from "@ogw_front/stores/hybrid_viewer";
 

package/app/components/Viewer/Generic/Model/SurfacesOptions.vue

@@ -4,7 +4,7 @@ import OptionsSection from "@ogw_front/components/Viewer/Options/OptionsSection.
 import type { RGBAColor } from "@ogw_front/utils/default_styles/constants";
 import ViewerOptionsColoringTypeSelector from "@ogw_front/components/Viewer/Options/ColoringTypeSelector.vue";
 import VisibilitySwitch from "@ogw_front/components/Viewer/Options/VisibilitySwitch.vue";
-import back_schemas from "@geode/opengeodeweb-back/opengeodeweb_back_schemas.json";
+import back_schemas from "@geode/opengeodeweb-back/opengeodeweb_back_typed_schemas.js";
 import { useDataStyleStore } from "@ogw_front/stores/data_style";
 import { useHybridViewerStore } from "@ogw_front/stores/hybrid_viewer";
 

package/app/components/Viewer/Options/ColoringTypeSelector.vue

@@ -4,7 +4,7 @@ import type { RGBAColor } from "@ogw_front/utils/default_styles/constants";
 import ViewerOptionsAttributeSelector from "@ogw_front/components/Viewer/Options/AttributeSelector.vue";
 import ViewerOptionsColorPicker from "@ogw_front/components/Viewer/Options/ColorPicker.vue";
 import ViewerOptionsTexturesSelector from "@ogw_front/components/Viewer/Options/TexturesSelector.vue";
-import back_schemas from "@geode/opengeodeweb-back/opengeodeweb_back_schemas.json";
+import back_schemas from "@geode/opengeodeweb-back/opengeodeweb_back_typed_schemas.js";
 
 interface Texture {
   id: string;

package/app/components/Viewer/Options/TextureItem.vue

@@ -1,6 +1,6 @@
 <script setup lang="ts">
 import FileUploader from "@ogw_front/components/FileUploader.vue";
-import back_schemas from "@geode/opengeodeweb-back/opengeodeweb_back_schemas.json";
+import back_schemas from "@geode/opengeodeweb-back/opengeodeweb_back_typed_schemas.js";
 import { useBackStore } from "@ogw_front/stores/back";
 
 // Mirrors FileUploader's own (unexported) UploadFile type.
@@ -46,10 +46,8 @@ function getTextureCoordinates(): void {
   backStore.request(
     { schema, params },
     {
-      response_function: (response: unknown) => {
-        textureCoordinates.value = (
-          response as { texture_coordinates: string[] }
-        ).texture_coordinates;
+      response_function: (response) => {
+        textureCoordinates.value = response.texture_coordinates;
       },
     },
   );
@@ -69,8 +67,8 @@ async function files_uploaded_event(value: UploadFile[]): Promise<void> {
     await backStore.request(
       { schema, params },
       {
-        response_function: (response: unknown) => {
-          textureId.value = (response as { id: string }).id;
+        response_function: (response) => {
+          textureId.value = response.id;
         },
       },
     );

package/app/composables/global_attribute_style.ts

@@ -1,5 +1,5 @@
 import type { JsonRpcSchema } from "@ogw_shared/utils/types";
-import back_schemas from "@geode/opengeodeweb-back/opengeodeweb_back_schemas.json";
+import back_schemas from "@geode/opengeodeweb-back/opengeodeweb_back_typed_schemas.js";
 import { getAttributeRange } from "@ogw_front/utils/attributes";
 import { useBackStore } from "@ogw_front/stores/back";
 import { useDataStyleStore } from "@ogw_front/stores/data_style";

package/app/composables/project_manager.ts

@@ -1,4 +1,4 @@
-import back_schemas from "@geode/opengeodeweb-back/opengeodeweb_back_schemas.json";
+import back_schemas from "@geode/opengeodeweb-back/opengeodeweb_back_typed_schemas.js";
 import fileDownload from "js-file-download";
 import viewer_schemas from "@geode/opengeodeweb-viewer/opengeodeweb_viewer_schemas.json";