Packages > pkg.pkl-lang.org/pkl-pantry/org.json_schema.contrib

org.json_schema.contrib.generate1.0.1

Overview
Properties
Methods

module org.json_schema.contrib.generate

Generate Pkl sources from JSON Schema documents.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/generate.pkl
Pkl version:: 0.25.0 or higher
Source code:: generate.pkl
Known subtypes:
Known usages:
All versions:: 1.1.4, 1.1.3, 1.1.2, 1.1.1, 1.1.0, 1.0.9, 1.0.8, 1.0.7, 1.0.6, 1.0.5, 1.0.4, 1.0.3, 1.0.2, 1.0.1, 1.0.0

Limitations:

Cannot generate not, allOf, or anyOf combinators correctly due to limitations in Pkl's model.
- Union types exist, but they are logically the same as oneOf (only one subschema can match).
- Intersection types do not exist (can use this to model allOf).
Doesn't generate correct types for schemas that use both JsonSchema.properties and JsonSchema.additionalProperties because classes cannot contain entries (known limitation, will be addressed in a future Pkl release). Some possible workarounds:
- Add a child Mapping property to represent "additional properties" and add a renderer to inline them/
- Add an option to the generator to control whether a class or a Mapping gets generated.
Cannot generate JsonSchema.patternProperties fully (this is a limitation of Pkl). If there is just one pattern property, it gets generated as a Mapping. Otherwise, this falls back to Dynamic, which is the loosest constraint.
Cannot generate tuple types (this is missing in Pkl).
Properties called default cannot be generated (currently a limitation of the json parser).

TODO:

Handle usages of allOf. We can do this by merging subschemas into a larger schema.
Copy doc comments from a class or typealias to its usage sites if there isn't a doc comment already.
Handle if schema root is not an object type (Example: ansible's schema root has "type": "array").
Handle if schema root should be a mapping (it has additionalProperties or patternProperties set).

Sample CLI usage:

pkl eval package://pkg.pkl-lang.org/pkl-pantry/org.json_schema.contrib@<version>#/generate.pkl \
  -m . \
  -p source="https://json.schemastore.org/github-action.json"

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```