schema: candidate plugin for json schema validation #1861

tinygiant98 · 2026-01-23T20:25:24Z

This plugin candidate implements a javascript-based json schema validator (Another Json Validator). JS was selected because it's the language of the web and generally kept up to date better than pure-cpp versions (the latest stable cpp version was still at draft 7, js versions are up to date to the soon-to-be-released v1), making updating to current json-schema.org releases much easier.

Info, documentation and examples are in the readme.

~~This PR requires nwnx-builder to be republished.~~

Daztek · 2026-01-24T09:28:14Z

Plugins/Schema/CMakeLists.txt

+add_custom_command(
+    OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/ajv_bundle_data.h"
+    COMMAND xxd -i "ajv_runtime.min.js" "${CMAKE_CURRENT_BINARY_DIR}/ajv_bundle_data.h"
+    WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/external/ajv/dist"
+    DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/external/ajv/dist/ajv_runtime.min.js"
+    VERBATIM
+)


Could we not run this locally and just bundle ajv_bundle_data.h in the tree? We'd get rid of the xxd dependency and wouldn't have cmake doing this each compile

Yes, we can. However, I included this here to make updating the ajv bundle easier if and when there is an ajv or quickjs update as it didn't seem too heavy a load to run during the target build process. A quickjs update isn't all that necessary, but ajv (and its associated bundle) could be updated relatively often to support the latest schema (both of the support systems have scripts for updating them). If the static header is compiled and included, then the xxd requirement in the builder would go away, but it would levy an additional local environmental requirement (xxd or similar) on the updater's machine.

The options as I see them are:

Remove this compilation step and levy the local environmental requirement for compilation on the updater's machine before commit.

Remove this compilation step and add the compilation as a GHA step if/when updated ajv files are committed.

Leave as is.

I'm fine with any of them. I'm going to assume (1) is your preferred choice, so I'll move in that direction today, removing the xxd requirement from the builder, modifying the ajv update script and editing the cmakelists and readme. Let me know if that's an incorrect assumption and I'll correct course. Thanks!

Looking at the ajv repo on github and npm it doesn't look like it's updated that often, last time was in 2024ish. So just having the ajv_bundle_data.h in the tree seems best to me, if there happens to be an update someone can just PR it

Resolved in 6c4f00f.

Daztek · 2026-01-24T14:39:46Z

builder.Dockerfile

@@ -23,7 +23,7 @@ RUN buildDeps="build-essential \
    autoconf \
    automake \
    bison \
-    ccache" \
+    ccache \


Please readd the double quote or everything'll explode at some point :D

Resolved in b35d3f6.

Daztek · 2026-01-24T14:40:14Z

Plugins/Schema/NWScript/nwnx_schema.nss

+/// @return A json object containing validation results.
+json NWNX_Schema_ValidateInstanceByID(json jInstance, string sSchemaId, int nVerbosity = NWNX_SCHEMA_OUTPUT_VERBOSITY_NORMAL);
+
+int NWNX_Schema_GetIsRegistered(string sSchemaId) {


Style nit: braces should be on their own line

Resolved in 19211fc.

You missed nwnx_schema.nss I think!

Wow, I think that's the first time I've ever written an .nss file with inline braces. Fixed in 6fc9498.

Daztek · 2026-01-24T14:40:33Z

Plugins/Schema/Schema.cpp

+static json JSValueToJSON(JSValue val);
+
+void SchemaUnload() __attribute__((destructor));
+void SchemaUnload() {


Style nit: braces should be on their own line

Resolved in 19211fc.

Daztek · 2026-01-24T14:49:47Z

Plugins/Schema/CMakeLists.txt

@@ -0,0 +1,25 @@
+add_shared_plugin(Schema


add_plugin() didn't work here?

Resolved in de0cef6.

Daztek · 2026-01-24T14:53:37Z

Plugins/Schema/CMakeLists.txt

@@ -0,0 +1,25 @@
+add_shared_plugin(Schema
+    "Schema.cpp"
+    "${CMAKE_CURRENT_SOURCE_DIR}/external/ajv/dist/ajv_bundle_data.h"


${CMAKE_CURRENT_SOURCE_DIR}/ is probably not needed?

Resolved in de0cef6.

Daztek · 2026-01-24T14:53:51Z

Plugins/Schema/CMakeLists.txt

+    ${CMAKE_SOURCE_DIR}            
+    ${CMAKE_CURRENT_SOURCE_DIR}   
+    ${CMAKE_CURRENT_BINARY_DIR}    


Are these needed?

Resolved in de0cef6.

Daztek · 2026-01-24T14:54:17Z

Plugins/Schema/CMakeLists.txt

+    CONFIG_VERSION="2026"          
+)
+
+set_target_properties(Schema PROPERTIES LINK_FLAGS "-rdynamic")


Is this needed?

Resolved in de0cef6.

Daztek · 2026-01-24T15:02:31Z

Plugins/Schema/Schema.cpp

+        js_std_init_handlers(global_rt);
+        js_std_add_helpers(global_ctx, 0, NULL);
+
+        const char* js = R"(


I think this, and the others like it, can be static constexpr const char* so they're basically compile time constants

Resolved in afa8a9a.

Daztek · 2026-01-25T08:30:16Z

Before I forget, don't forget to add your plugin under the New Plugins header in CHANGELOG.md

tinygiant98 added 2 commits January 23, 2026 15:22

schema: candidate plugin for json schema validation

3165ca7

schema: migrate to ctor/dtor standard

6c4f00f

Daztek reviewed Jan 24, 2026

View reviewed changes

schema: remove header compilation from cmake build process

190e7d4

Daztek reviewed Jan 24, 2026

View reviewed changes

tinygiant98 added 4 commits January 24, 2026 10:52

schema: convert javascript functions to static strings

afa8a9a

schema: resolve code style nits

19211fc

schema: fix builder dockerfile

b35d3f6

schema: remove unnecessary cmake inclusions

de0cef6

tinygiant98 added 2 commits January 25, 2026 09:00

schema: resolve (more) code style nits

6fc9498

schema: add plugin to changelog

bcaad03

schema: candidate plugin for json schema validation #1861

Are you sure you want to change the base?

schema: candidate plugin for json schema validation #1861

Uh oh!

Conversation

tinygiant98 commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Daztek Jan 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Daztek commented Jan 25, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

tinygiant98 commented Jan 23, 2026 •

edited

Loading

Daztek Jan 24, 2026 •

edited

Loading