CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

v3.1.2 - 2023-06-15

Fixed

• Fix failing ESM imports with file extension

v3.1.1 - 2023-06-01

Fixed

• Ensure paths are treated correctly on Windows (#116)

v3.1.0 - 2022-08-12

Changed

• Prevent ClassLoader from throwing error on invalid packages, Closes #95
• Prevent ExternalModulesLoader from throwing error on invalid packages, Closes #95

v3.0.5 - 2022-06-27

Fixed

• Fix incorrect handling of recursive types

v3.0.4 - 2022-06-01

Fixed

• Fix process halting on recursive types

v3.0.3 - 2022-04-27

Fixed

• Fix resolution of an index.d.ts inside a directory, Closes #99

v3.0.2 - 2022-03-15

Fixed

• Add path expansion for Windows users, Closes #96

v3.0.1 - 2022-03-02

Fixed

• Fix Components.js version range being too strict

v3.0.0 - 2022-03-01

Changed

• Update to CJS 5
• Update dependency @types/node to v16

v3.0.0-beta.7 - 2022-02-08

Added

• Add support for never param types as wildcard, Closes #85

v3.0.0-beta.6 - 2022-01-29

Added

• Add lenient generation mode to ignore unsupported lang features
• Support indexed access type param ranges
• Support keyof typeof enum as union of enum keys

Changed

• Emit typed memberFields instead of memberKeys
• Ignore TSMappedType during generation
• Ignore unsupported function types

Fixed

• Fix empty context shortcuts being generated in some cases

v3.0.0-beta.5 - 2022-01-17

Added

• Generate wildcard parameter ranges
• Improve generics support:
  • Output generic type instances on class/iface extensions
  • Generate wrapped comp extensions as GenericComponentExtension
• Handle references to external packages that do no expose components
• Cache interface range resolution

Fixed

• Inherit qualified path on class/iface chains
• Fix resolution not working on type-only packages, Closes #83
• Don't resolve as nested fields when handling extension data
• Emit @type of ExtensionDefinitions
• Fix qualified path incorrectly propagating to extension defs
• Don't throw on hash range when getNestedFields is false
• Fix generics not being generated for interfaces

v3.0.0-beta.4 - 2021-12-09

Added

• Handle keyof param ranges
• Export component member keys, for keyof checking
• Handle generics in type aliases
• Allow fieldNameToId to refer to other packages
• Support qualified paths:
  • Support qualified paths in ignored components
  • Support parameters referring to components with qualified paths
• Support enum and enum value parameter ranges

Changed

• Return undefined for nested parameter ranges
• • Improve error message for unsupported nested fields

Fixed

• Fix stackoverflow on generic remapping with self-references

v3.0.0-beta.3 - 2021-12-07

Added

• Generate all relevant generic type data of classes and params

v3.0.0-beta.2 - 2021-12-02

Fixed

• Fix class types not being overridable, Closs #82

v3.0.0-beta.1 - 2021-12-02

Added

• Allow type aliases for interfaces and classes

v3.0.0-beta.0 - 2021-11-30

Requires Components.js >= 5.0.0

BREAKING CHANGES

• Enable type scoped context functionality by default: This means that the --typeScopedContexts CLI option should not be passed anymore.
• Make component URLs dereferenceable: This improves the URL strategy for components, and results in different component URLs.
• Align with Components.js range changes:
  • Remove 'unique' field option in favor of array param type
  • Remove 'required' field option in favor of union with undefined
  • Explicitly serialize undefined parameter ranges
• Set minimum Node version to 12

Added

• Allow configuration using config file
  • Allow package paths to be ignored
• Improve TypeScript language support:
  • Support components defined within namespaces via export assignment
  • Support imports for packages that have external @types packages
  • Support type literals and type aliases
  • Generate param ranges with tuples and rest types
  • Generate param ranges with union and intersection types
• Improve tag support:
  • Allow multiple @default values to be defined
  • Fix @ symbols not being allowed in comment data
  • Allow setting default JSON values
  • Allow default IRI values to be relative
  • Allow defaultNested tags to be added with typed values
  • Keep structural param type information on overrides
  • Allow default values to be IRIs when wrapped in <>
• Add shorter param entries in type-scoped context when possible.
• Enable generation of multiple packages in bulk: This allows this generator to be used in monorepos
• Add option to dump debug state
• Allow constructor comment data inheritance from supers
• Allow interface args to extend from other interfaces, Closes #73
• Also consider recursive deps when loading external modules
• Allow components from other packages to be re-exported

Fixed

• Fix default values not being in an RDF list when needed
• Fix @list not being applied on optional arrays
• Fix crash when loading fields from super interface chains

Changed

• Reduce unneeded logging
• Ignore imports that fail
• Allow components to be part of multiple modules
• Fix param range resources using @type instead of @id

v2.6.1 - 2021-09-29

Fixed

• Fix optional types not always being parsed correctly, Closes #74

v2.6.0 - 2021-07-20

Added

• Add CLI parameter to set prefix of package

v2.5.0 - 2021-06-30

Added

• Mark array properties as RDF list (support for empty arrays)
• Strip away unsupported types in constructor arguments
• Support keywords like 'public' in constructor args

v2.4.0 - 2021-06-14

Added

• Interpret @range {json} as rdf:JSON params

v2.3.0 - 2021-06-08

Added

• Generate interface-based components

v2.2.0 - 2021-05-19

Added

• Allow components from third-party packages to be used, Closes #39

v2.1.0 - 2021-01-18

Added

• Add experimental typeScopedContexts flag

Fixed

• Fix build error when source or target path occurs 1+ times in path

v2.0.0 - 2021-01-14

Added

• Use prefetched document loader for offline context access, Closes #51
• Add support for lsd:module true in package.json

Changed

• Update context shortcuts to support JSON-LD 1.1
• Update to Components.js context version 4

Fixed

• Fix file prefixing always using 1.0.0, Closes #52

v1.6.0 - 2020-11-24

Added

• Allow param range to be undefined when its class range is ignored

v1.5.0 - 2020-11-23

Added

• Allow classes to be ignored via JSON file, Closes #40

Changed

• Set tsconfig target to es2017

v1.4.1 - 2020-11-09

Fixed

• Fix collectEntries params being required and unique
• Fix indexed field names appearing twice in IRIs

v1.4.0 - 2020-11-06

Added

• Translate Record type aliases into hashes, Closes #47

Changed

• Be less strict in how typings are defined in package.json

v1.3.0 - 2020-11-02

Changed

• Fix incorrect package name, Closes #45
• Use 'types' property to detect index.d.ts file
• Ensure unique field names within a class, Closes #44

v1.2.0 - 2020-10-27

Added

• Handle indexed hashes as collectEntries parameters, Closes #43

v1.1.0 - 2020-09-07

Added

• Handle generically typed parameters

Fixed

• Fix exiting with code 0 on error

v1.0.1 - 2020-08-28

Fixed

• Make library path handling OS independent

[v1.0.0] - 2020-08-27

Initial release