All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Improves the error message surfaced in cases where FROID generates an empty key.
- Fixes a case where sub-entity keys failed to roll up properly to referencing entity keys when a value type was in-between.
- Added a new option for an
omittedEntityQualifierto re-evaluate and include entities that may have been erroneously omitted by thenodeQualifier. This provided the flexibility to fix missing entities while preserving previous behavior
- The
FroidSchemaclass does not include all enum values found across subgraphs when enum definitions differ.
- Added a new
FroidSchemaclass to test the next version of FROID schema generation. - FROID schema is now sorted (both new and old version) and include documentation string.
- Applying the
@tagdirective to an entity'sidfield could fail if the only@tagdirective in the entity was applied to a field argument. This fix now considers field argument@tags as well as field@tags when selecting theidfield's@tag(s).
- The federation version is no longer provided as an enum value. It must now be
provided as a string of either
v1or a validv2.xversion (examples:v2.1,v2.3, etc.). - Fixes to complex key schema generation and federation v1 value type schema generation could effect the generated schema. Please carefully compare schema generated with the previous version against schema generated after upgrading.
- Added support for a custom key sorter. This allows for a custom key preference to be applied prior to selecting the first key.
- Added support for explicitly defining the federation version, either
v1or a validv2.xversion (examples:v2.1,v2.3, etc.)
- In some cases, if a complex key included a nested entity but was not using the entity's key, schema generation would fail to include the nested entity's key field(s).
- In some cases, if a type appeared in multiple subgraphs and was being used in multiple complex keys but with different field selections, not all fields would be included in the generated schema.
- When generating Federation v1 schema, value types would erroneously receive
the
extendkeyword and their fields would erroneously receive the@externaldirective.
- Add support for a custom schema node qualifier when generating node-relay schema so users can determine whether or not to include an entity in the generated node-relay schema based on custom criteria
- Omit
@interfaceObjects prior to generating node-relay schema to avoid breaking federation composition
- Sort the key values encoded in an id to ensure they are deterministically generated
- @key directive selection in schema generation now picks the first directive where fields doesn't specify a nested complex key.
- Fix applied to when entities are specified in a nested complex key field, they were generated as non-entity types in the Froid schema.
- Fix issue where non-resolvable entity references in Federation 2 were processed during Froid schema generation
- Support enum generation specified as @key fields.
- cleanup distributed files when publishing packages
- Public release
- feat: add better error handling support
- Updated
handleFroidRequest.options.decodeAPI fromstring -> objecttostring -> stringto remove inconsistency across the encode/decode APIs. Now all JSON parsing happens in the core implementation.
- Properly export typescript types in published package
- Include
distdirectory in published package
- Add initial library API:
handleFroidRequest: Handles bothidgeneration as well asnodefield parsing of Object Identification requests in Federation.generateFroidSchema: Generates schema for the Froid subgraph, complete with Federation 1 & 2 support, as well as Apollo contracts!