Add an optional identifier to plugins

[jdesrosiers]

The original goal of the AST was for it be me fully JSON serializable. The one place I deviated from that goal was to allow RegExp values. This was to improve efficiency and it seemed reasonable because it's fairly easy to convert a RegExp to a string and back to JSON with builtin tools.

However, it didn't occur to me when I added the plugin system that I was adding something that isn't serializable. We need to figure out something to fix that.

I think the minimum we need to do is to give plugins an identifier. That would allow a hook for a JSON.stringify replacer to store something that can be used to restore the plugin. The application implementing serialization will need to maintain a plugin registry for the plugins they support mapping the identifier to the plugin, but that shouldn't be be challenging.

[jdesrosiers]

Related to rjsf-team/react-jsonschema-form#4923

[srivastava-diya]

Hey @jdesrosiers
This is what i think we can do

• Update the EvaluationPlugin interface in lib/experimental.d.ts

  1. Add a optional id?: string property to the EvaluationPlugin interface.
  2. Add id: string to BasicOutputPlugin, DetailedOutputPlugin, and AnnotationsPlugin class declarations

• Add an id property to the following built-in plugins:

  1. BasicOutputPlugin : https://json-schema.hyperjump.io/plugins/basic-output
  2. DetailedOutputPlugin : https://json-schema.hyperjump.io/plugins/detailed-output
  3. AnnotationsPlugin : https://json-schema.hyperjump.io/plugins/annotations

• also update the readme.md

Please let me know if this approach works and feel free to assign me

[jdesrosiers]

That's exactly what I had in mind, but you're missing the most important plugins for the serialization use-case. The plugins that are affected by serialization are the keyword-specific plugins defined in the dynamicRef, unevaluatedProperties, and unevaluatedItems keywords handlers.

[srivastava-diya]

@jdesrosiers, Thankyou so much for pointing that out and i think in addition to those 3 we also need to consider
draft-2020-12/dynamicRef as it will also get affected by serialization.

Also, a quick question what should the id for these keywords look like? something like this
https://json-schema.hyperjump.io/plugins/dynamicRef or like https://json-schema.org/keyword/dynamicRef#plugin

[jdesrosiers]

It shouldn't really matter what the URI is as long as it's unique, but I like the second option better.