v2.0.1

2.0.1 (2024-04-12)

Bug Fixes

• emit type defs and include in release (#11) (8eadb4d)

v2.0.0

2.0.0 (2024-04-12)

Bug Fixes

• correct the event name for manual dispatch (fe9db03)
• escape property names that are invalid identifiers (#9) (67e439c), closes #7
• improve typescript specificity on util func (39f8ef9)
• rename release workflow to get around GitHub bug (hopefully) (92451db)
• tweak actions syntax for repository_dispatch event (d40f1a5)

chore

• setup semantic release (1df7803)
• update all dependencies and modernize (#10) (9832757)

BREAKING CHANGES

• This change bumps the minimum node version to Node 18.12.0 (LTS).

• chore: drop node 16 from CI matrix

• This commit introduces semantic release and for that
  we're bumping the major version.

v1.5.0

Added

• Added support for opting out of emitting the @see directives in schema doc comments through the omitIdComments option. By default, these tags will be emitted to preserve backwards-compatibility. To omit these comments, omitIdComments: true can be specified as an option.
• Introduce the shouldOmitTypeEmit option to the compile method of Parser instances. This option allows consumers to conditionally skip the emit of some sub-schemas' types. This function receives references to the child node being emitted and the parent node.

v1.4.1

Fixed

• Added package-lock.json to fix release tooling.

v1.4.0

Added

• The type used for open-ended schemas can be passed via the anyType option in the Partser's generateTypings method.

  Some use-cases may demand strict typing for values whose shape cannot be known a priori, in which case "unknown" would be a good fit. In other cases, a consumer of an object typed using this library might find it helpful to know that only JSON-serializable values can be present. In that case, the "JSONValue" option would be suitable. Finally, in cases where consumers of the type definitions may want minimal friction from the type-checker, "any" might be the best choice.

v1.3.0

Added

• Add support for passing a preferredName for the generated type when calling .addSchema in a new options argument. If the preferred name is already taken, the returned type name will be <preferredName><ordinalCounterValue>. [#2]