Serializer and Documentator improvements 🦀

Mark	Type	Count	Packages
	Features	7	documentator, serializer
	Bug Fixes	2	documentator, serializer
💀	Deprecations	2	core, documentator

Package core

Deprecations 💀

• InstanceCache (b21ca92)

Package documentator

Features

• Added depth parameter for IncludeDocumentList (include:document-list) instruction (41536fc)
• IncludeTemplate (include:template) instruction. IncludeFile (include:file) will not replace variables anymore (3165f2a)
• Parameterizable instructions (574cef2)
• Variables support for IncludeFile (include:file) instruction (e9c0df9)

Bug Fixes

• Normalization of Preprocessor hash calculation for parameters (117cc4e)

Deprecations 💀

• LastDragon_ru\LaraASP\Documentator\Preprocessor\Instruction (please use LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\Instruction and its subclasses instead) (a5076ff)

Package serializer

Features

• AsSerializable eloquent cast (8b370e1)
• DiscriminatorMap support (for SerializableNormalizer) (cafa2eb)
• VersionMap attribute to add version for Serializable (5a22197)

Bug Fixes

• Serializer::serialize()/Serializer::deserialize() accept any object as it defined in docs (ecfb8d6)

The `@stream` directive and two new packages 🤠

Mark	Type	Count	Packages
☣	Breaking changes	16	eloquent, graphql, graphql-printer
	Features	11	*, documentator, graphql, graphql-printer, testing
	Performance Improvements	1	graphql
	Bug Fixes	10	documentator, eloquent, graphql, graphql-printer, testing
	Miscellaneous	1	*
	Code Refactoring	8	graphql

The new major release introduces the new @stream directive and two new packages: the Serializer and Documentator. Please also see 5.0.0-beta.0 and 5.0.0-beta.1 release notes.

All packages

Features

• PHP 8.3 Support (#103, 34296a9)

Miscellaneous

• Minimum version of Laravel Scout set to ^9.8.0 (9fb9df4)

Package documentator

Features

• requirements command will dump requirements for Metadata { version } equal to HEAD even if no git tag (993d002)

Bug Fixes

• Command processing for include:exec instruction (d47f127)
• HTML entities encoding for include:document-list and include:package-list (0d2bd41)
• missed artisan prefix for command usages (lara-asp-documentator:commands) (cfc9973)
• Missed EOF in Metadata.json (7b77228)

Package eloquent

Bug Fixes

• new ModelHelper(Model::class) will be identical to new ModelHelper(Model::query()) (makes no sense to create a query with invalid constraints for relations) (1e4e213) ☣

Package graphql

Features

• @stream directive (#101, 2382b6c)
• Added JsonString wrapper/helper (to return JSON without unnecessary validation) (6a6953d)
• JsonString scalar (06ad9be)
• TypeDefinition can be fully replaced via Container (TypeDefinition::getTypeName() became is non static) (0ee21c7) ☣
• @searchby: Scout support for NotIn operator (laravel/scout:>=10.3.0 required). (#98, f555270)

Performance Improvements

• AstManipulator::getTypeFullName() no unnecessary fetching for definitions (45f1cf6)

Bug Fixes

• AstManipulator::addTypeDefinition() will convert ScalarType into scalar and will add it into Document instead of TypeRegistry (3e23e8e)

Code Refactoring

• Added TypeSource::isUnion() (026f118) ☣
• Added TypeSource argument to BuilderInfoProvider::getBuilderInfo() (f29215a) ☣
• ArgumentNode support for AstManipulator::getName(); DirectiveNode support for AstManipulator::findArgument(), AstManipulator::getArgument() (cb29569) ☣
• BuilderInfoDetector internally will use TypeSource instead of Node (fb0b6f7) ☣
• BuilderInfoProvider::getBuilderInfo() can return only ?BuilderInfo (you can use BuilderInfo::create() to get a default instance for class) (630ff3b) ☣
• Directive::Name consts marked as final (757fd7d) ☣
• JsonString renamed to JsonStringType (8cf2761) ☣
• WithBuilderInfo trait converted into BuilderInfoDetector class (a819d8e) ☣

Package graphql-printer

Features

• New setting Settings::isAlwaysMultilineDirectives() (#82, 212b61c) ☣
• New setting Settings::isNormalizeDirectives() (default is false, because the order of directives may be important) (1db945b) ☣
• Settings::isNormalizeSchema() renamed to Settings::isNormalizeDefinitions() (cacf098) ☣

Bug Fixes

• Default value Settings::isNormalizeArguments() set to false because the order of arguments may be important (5198e6e)
• Exported type will be on the top of the document (#100, 5b9e5b2) ☣
• Object value will respect Settings::isAlwaysMultilineArguments() (4a8b916)

Package testing

Features

• New assertion WithQueryLog::assertQueryLogEquals() (3068f60)

Bug Fixes

• Scout v10.3.0 assertions fix (c03d563)

Scout v10.3.0 support

Mark	Type	Count	Packages
	Features	2	core, graphql
	Performance Improvements	1	formatter
	Bug Fixes	4	graphql, graphql-printer, migrator, testing

Package core

Features

• New helper ProviderWithViews (81eecca)

Package formatter

Performance Improvements

• Formatter registered as a singleton (via Container::scopedIf()) (65fe453)

Package graphql

Features

• @searchby: Scout support for NotIn operator (laravel/scout:>=10.3.0 required) (cd24d54)

Bug Fixes

• AstManipulator::addTypeDefinition() will convert ScalarType into scalar and will add it into Document instead of TypeRegistry (3647e1a)

Package graphql-printer

Bug Fixes

• Object value will respect Settings::isAlwaysMultilineArguments() (f09e251)

Package migrator

Bug Fixes

• Added missed AsCommand attribute (8a29642)

Package testing

Bug Fixes

• Scout v10.3.0 assertions fix (285dd15)

Documentation Preprocessor

Mark	Type	Count	Packages
☣	Breaking changes	3	core
	Features	9	core, documentator
	Performance Improvements	1	formatter
	Bug Fixes	8	documentator, migrator
	Miscellaneous	1	*
	Code Refactoring	3	core

All packages

Miscellaneous

• Minimum version of Laravel set to ^9.21.0 (6687343)

Package core

Features

• New helper ProviderWithViews (972ed3f)
• New package helper Viewer (9502ebe)

Code Refactoring

• Config, routes, translations and views moved into defaults directory (b4486e8) ☣
• LastDragon_ru\LaraASP\Core\Translator and LastDragon_ru\LaraASP\Core\Helpers\Translator (a5d98e4) ☣
• ProviderWith* traits moved into LastDragon_ru\LaraASP\Core\Provider\With* (39b2b22) ☣

Package documentator

Features

• Command lara-asp-documentator:commands to save commands help into Markdown files (6de62b4)
• Command lara-asp-documentator:preprocess to preprocess Markdown files (0fa1e6e)
• Command lara-asp-documentator:requirements to generate a table with the required versions of PHP/Laravel in Markdown format (2842250)
• IncludeExample::Limit increased to 50 lines (6a737fc)
• IncludeExample can include raw markdown output via <markdown>raw</markdown> tag (caaa368)
• New package (#96, cfbcd41)
• Required requirements for Requirements command can be specified in metadata.json (bdb767f)

Bug Fixes

• Empty Requirements output (e65dbad)
• IncludeExample will merge multiple LF while counting lines (e69abd8)
• PackageTranslator will use proper package name (bed2912)
• Requirements cache (9c183b0)
• Requirements command output will include header (92bdcd1)
• Requirements command will not include the required version if it is empty (4a62f86)
• Requirements command will work correctly inside repository (61c494d)

Package formatter

Performance Improvements

• Formatter registered as a singleton (via Container::scopedIf()) (2091790)

Package migrator

Bug Fixes

• Added missed AsCommand attribute (c61e830)

The Serializer and deprecation removal

Mark	Type	Count	Packages
☣	Breaking changes	19	*, core, graphql, graphql-printer
	Features	4	graphql, graphql-printer, serializer
	Performance Improvements	1	graphql
	Miscellaneous	3	*, graphql, migrator, testing
	Code Refactoring	15	*, core, graphql, graphql-printer

All packages

Miscellaneous

• Drop symfony/*:<6.3 support (b67103e) ☣

Code Refactoring

• Drop PHP 8.0 Support (#95, 0a5bc5c) ☣

Package core

Code Refactoring

• Translator will not implement Illuminate\Contracts\Translation\Translator (to have stricter typehints) (e63d70d) ☣

Package graphql

Features

• BuilderInfoProvider::getBuilderInfo() can return null (748b56e) ☣
• GraphQLAssertions::useGraphQLSchema() will support DocumentAST too (ba97bb2) ☣

Performance Improvements

• AstManipulator::getDirectives(), AstManipulator::getDirective() (381fce4)

Miscellaneous

• Minimal version of nuwave/lighthouse set to ^6.5.0 (required for dynamic manipulator directives) (7954646)

Code Refactoring

• AstManipulator more methods, deprecated methods removal and fixes (9b62997) ☣
• Deprecated assertions removal (GraphQLAssertions::assertDefaultGraphQLSchemaEquals(), GraphQLAssertions::getGraphQLSchema(), GraphQLAssertions::useDefaultGraphQLSchema(), GraphQLAssertions::getDefaultGraphQLSchema(), GraphQLAssertions::printGraphQLSchema(), GraphQLAssertions::printGraphQLSchemaType(), GraphQLAssertions::printDefaultGraphQLSchema(), GraphQLAssertions::getGraphQLSchemaPrinter(), SchemaBuilderWrapper::default()) (9519a8c) ☣
• GraphQLAssertions::assertCurrentGraphQLSchemaEquals() => GraphQLAssertions::assertGraphQLSchemaEquals(), GraphQLAssertions::getCurrentGraphQLSchema() => GraphQLAssertions::getGraphQLSchema() (1b0543e) ☣
• HandlerDirective::getDirectives() removed (not used anymore) (aacd7b1) ☣
• Removed GraphQLAssertions::assertGraphQLSchemaEquals() (c6b5fba) ☣
• Removed Operator::getDirectiveName() (not needed/used anymore) (85ecda3) ☣
• Removed Operator::getFieldDirective() (not needed/used anymore) (83db54a) ☣
• TypeDefinition::getTypeDefinitionNode() => TypeDefinition::getTypeDefinition() (83fe3f7) ☣
• WithBuilderInfo::getBuilderInfo() will accept any Node (a4dcdbe) ☣

Package graphql-printer

Features

• Added Printer::print(), Printer::export(), Printer::getSchema(), Printer::setSchema() (#78, a28167b) ☣

Code Refactoring

• Dead code removal (TypeUnsupported, LastDragon_ru\LaraASP\GraphQLPrinter\Testing\Package\TestSettings) (67ab470) ☣
• Deprecate Printer methods removal (Printer::printSchema(), Printer::printSchemaType(), Printer::printType(), Printer::getLevel(), Printer::setLevel()) (#78, 19bc16e) ☣
• Deprecated assertions removal (GraphQLAssertions::assertGraphQLSchemaEquals(), GraphQLAssertions::assertGraphQLSchemaTypeEquals(), GraphQLAssertions::assertGraphQLTypeEquals(), GraphQLAssertions::assertGraphQLNodeEquals(), GraphQLAssertions::printGraphQLSchema(), GraphQLAssertions::printGraphQLSchemaType(), GraphQLAssertions::printGraphQLType(), GraphQLAssertions::printGraphQLNode(), GraphQLAssertions::getGraphQLSchemaPrinter(), GraphQLExpectedNode, GraphQLExpectedType) (53cf4c2) ☣
• Removed deprecated GraphQLAssertions::getGraphQLSchema(), GraphQLExpectedSchema (3b27a92) ☣

Package migrator

Miscellaneous

• Drop doctrine/dbal v2 support (3996086)

Package serializer

Features

• New package (#92, 7e3aadf)

Package testing

Miscellaneous

• Drop doctrine/dbal v2 support (3996086)

Dependencies cleanup

Mark	Type	Count	Packages
	Miscellaneous	1

All packages

Miscellaneous

• Unused dependencies removal (960cc78)

Bugfixes 🐛

Bug Fixes

• graphql: @rename support (#88, #89, 5fe2536)

More `SchemaPrinter` improvements and fixes 🤗

Deprecations

• graphql: GraphQLAssertions::assertDefaultGraphQLSchemaEquals(), GraphQLAssertions::assertGraphQLSchemaEquals(), GraphQLAssertions::printDefaultGraphQLSchema() (596416a)
• graphql: GraphQLAssertions::getGraphQLSchema() (1c73db1)
• graphql: GraphQLAssertions::useDefaultGraphQLSchema(), SchemaBuilderWrapper::default() (10722ce)
• graphql-printer: GraphQLAssertions::assertGraphQLSchemaEquals(), GraphQLAssertions::assertGraphQLSchemaTypeEquals(), GraphQLAssertions::assertGraphQLTypeEquals(), GraphQLAssertions::assertGraphQLNodeEquals(), GraphQLAssertions::printGraphQLSchema(), GraphQLAssertions::printGraphQLSchemaType(), GraphQLAssertions::printGraphQLNode(), GraphQLAssertions::getGraphQLSchemaPrinter(), GraphQLExpectedNode, GraphQLExpectedSchema, GraphQLExpectedType (#78, 107b77c)
• graphql-printer: GraphQLAssertions::getGraphQLSchema() (f14e1c6)
• graphql-printer: LastDragon_ru\LaraASP\GraphQLPrinter\Testing\Package\TestSettings (5dc69a9)

Features

• graphql-printer: DefaultSettings will print all directives (2fd774c)
• graphql-printer: Added Printer::print() and Printer::export() (#78, bc1c8d1)
• graphql-printer: New assertion GraphQLAssertions::assertGraphQLNodeEquals() (0df00fc)
• graphql-printer: New assertions: GraphQLAssertions::assertGraphQLPrintableEquals() and GraphQLAssertions::assertGraphQLExportableEquals() (22a5007)

Bug Fixes

• graphql-printer: Printer::printType() and Printer::printNode() will not contain EOF (fa1d831)

`SchemaPrinter` improvements and fixes 🤗

Deprecations

• graphql-printer: LastDragon_ru\LaraASP\GraphQLPrinter\Exceptions::TypeUnsupported => LastDragon_ru\LaraASP\GraphQLPrinter\Exceptions::Unsupported (e0f24fe)
• graphql-printer: Printer::printSchema(), Printer::printSchemaType(), Printer::printType(), Printer::getLevel(), Printer::setLevel() (#78, 3479b9c)

Features

• graphql: Ability to re-use build-in operators in the schema/config (6ce5c81)
• graphql: Added default operators for Date, DateTime, DateTimeTz, DateTimeUtc Lighthouse's scalars (e312412)
• graphql-printer: Context::getType()/Context::getDirective() will throw error if Schema defined but type/directive is not found (22dda09)
• graphql-printer: AST Support (#77, #83, 103924d)
• graphql-printer: More accurate line length calculation (b83c4d6)
• graphql-printer: Query support (#72, 7163a3b)
• graphql-printer: Type filtering will work only if Schema is known (17c26dc)

Bug Fixes

• graphql-printer: Arguments indent for lists/objects values (bb35dae)
• graphql-printer: Directive definition length calculation (1980cba)
• graphql-printer: Type collecting for ObjectValueNode (3d5d3e8)
• graphql-printer: Type filter will be applied to schema operation types too (6735090)
• graphql-printer: Type filtering for ObjectValueNode (d0d774e)

Performance Improvements

• graphql-printer: TypeFilter/DirectiveFilter will be called only one time for each type/directive (7c4030e)

Miscellaneous Chores

• graphql-printer: DirectiveResolver can return DirectiveDefinitionNode (c997ffd)
• graphql/Printer: DirectiveResolver will not throw error if directive not found (6025213)
• graphql/Printer: DirectiveResolver will return DirectiveDefinitionNode instead of Directive (faster) (33b7a30)

`@rename` support 🐱‍🏍

Features

• graphql: @searchBy/@sortBy will support @rename (#80, 54502b5)

Bug Fixes

• graphql: Property::getChild() will use dot notation (required eg for @rename) (9b38a95)
• graphql: Reset types while testing (related to SchemaBuilderWrapper and GraphQLAssertions::getGraphQLSchema()) (9558c71)