spatie/schema-org

Breaking changes

Requires PHP 8.4. Support for PHP 8.2 and 8.3 has been dropped.

Quantity is gone. schema.org v30.0 reclassified Quantity as a DataType (like Text and Number), so it is no longer generated as a class. Spatie\SchemaOrg\Quantity, Contracts\QuantityContract and Schema::quantity() have been removed.

Distance, Duration, Energy and Mass lost their inherited properties. Because their only parent was Quantity, they no longer declare the twelve Thing properties (name, description, url, identifier, …) and no longer implement ThingContract, IntangibleContract or QuantityContract. Calls like Schema::distance()->name('…') still work at runtime through BaseType::__call, but static analysis, IDE completion and instanceof checks against those contracts will not.

Other changes

Thirteen new types: AuthenticateAction, ConferenceEvent, Credential, DENonprofitType, Error, ITNonprofitType, InstantaneousEvent, LoginAction, OperatingSystem, PerformingArtsEvent, ResetPasswordAction, RuntimePlatform, SequentialArt.

What's Changed

• Upgrade schema.org definitions to v30.0 by @endelwar in #244
• Keep the ReferencedType generator template in sync with src by @freekmurze in #246
• Upgrade test suite to Pest 5 by @freekmurze in #245

New Contributors

• @endelwar made their first contribution in #244

Full Changelog: 4.0.2...5.0.0

Breaking changes

Requires PHP 8.4. Support for PHP 8.2 and 8.3 has been dropped.

Quantity is gone. schema.org v30.0 reclassified Quantity as a DataType (like Text and Number), so it is no longer generated as a class. Spatie\SchemaOrg\Quantity, Contracts\QuantityContract and Schema::quantity() have been removed.

Distance, Duration, Energy and Mass lost their inherited properties. Because their only parent was Quantity, they no longer declare the twelve Thing properties (name, description, url, identifier, …) and no longer implement ThingContract, IntangibleContract or QuantityContract. Calls like Schema::distance()->name('…') still work at runtime through BaseType::__call, but static analysis, IDE completion and instanceof checks against those contracts will not.

Other changes

Thirteen new types: AuthenticateAction, ConferenceEvent, Credential, DENonprofitType, Error, ITNonprofitType, InstantaneousEvent, LoginAction, OperatingSystem, PerformingArtsEvent, ResetPasswordAction, RuntimePlatform, SequentialArt.

What's Changed

• Upgrade schema.org definitions to v30.0 by @endelwar in https://github.com/spatie/schema-org/pull/244
• Keep the ReferencedType generator template in sync with src by @freekmurze in https://github.com/spatie/schema-org/pull/246
• Upgrade test suite to Pest 5 by @freekmurze in https://github.com/spatie/schema-org/pull/245

New Contributors

• @endelwar made their first contribution in https://github.com/spatie/schema-org/pull/244

Full Changelog: https://github.com/spatie/schema-org/compare/4.0.2...5.0.0

What's Changed

• Escape HTML tags in toScript() output to prevent script break-out by @freekmurze in #242

Values containing </script> passed as schema properties could break out of the generated <script type="application/ld+json"> block and execute injected HTML when the value was attacker-controlled. toScript() now emits < and > as \u003C / \u003E, which is valid JSON-LD and is no longer parsed as an HTML tag by the browser. Affects 3.23.1 through 4.0.1.

Full Changelog: 4.0.1...4.0.2

What's Changed

• Escape HTML tags in toScript() output to prevent script break-out by @freekmurze in https://github.com/spatie/schema-org/pull/242

Values containing </script> passed as schema properties could break out of the generated <script type="application/ld+json"> block and execute injected HTML when the value was attacker-controlled. toScript() now emits < and > as \u003C / \u003E, which is valid JSON-LD and is no longer parsed as an HTML tag by the browser. Affects 3.23.1 through 4.0.1.

Full Changelog: https://github.com/spatie/schema-org/compare/4.0.1...4.0.2

What's Changed

• Resolve @id without cascading toArray() in ReferencedType by @freekmurze in #241

Full Changelog: 4.0.0...4.0.1

What's Changed

• Resolve @id without cascading toArray() in ReferencedType by @freekmurze in https://github.com/spatie/schema-org/pull/241

Full Changelog: https://github.com/spatie/schema-org/compare/4.0.0...4.0.1

What's Changed

• Upgrade schema.org definitions to v29.3 (#238 by @Soean)
• Drop PHP 8.0 and 8.1 support (now requires PHP ^8.2)
• Add PHP 8.5 support
• Add JSON_UNESCAPED_SLASHES to toScript() output
• Upgrade dev dependencies (Pest 2/3, PHPUnit 10, Symfony 6/7)
• Upgrade phpunit.xml.dist to PHPUnit 10 format
• Add return type declarations to generator commands

What's Changed

• Upgrade schema.org definitions to v29.3 (#238 by @Soean)
• Drop PHP 8.0 and 8.1 support (now requires PHP ^8.2)
• Add PHP 8.5 support
• Add JSON_UNESCAPED_SLASHES to toScript() output
• Upgrade dev dependencies (Pest 2/3, PHPUnit 10, Symfony 6/7)
• Upgrade phpunit.xml.dist to PHPUnit 10 format
• Add return type declarations to generator commands

What's Changed

Backport of the </script> break-out fix (#242) onto the 3.x line, so projects still on spatie/schema-org 3.x can apply the security patch without upgrading to 4.x.

toScript() now adds JSON_HEX_TAG to the json_encode flags. The < and > characters in property values are now serialized as their JSON unicode escapes instead of raw angle brackets, which is valid JSON-LD but cannot be parsed as an HTML tag. This neutralizes the break-out vector reported in the advisory (affected: 3.23.1 through 4.0.1).

Thanks to @hacklian for reporting (#243) and supplying the backport patch.

Full Changelog: 3.23.1...3.23.2

What's Changed

Backport of the </script> break-out fix (#242) onto the 3.x line, so projects still on spatie/schema-org 3.x can apply the security patch without upgrading to 4.x.

toScript() now adds JSON_HEX_TAG to the json_encode flags, so < and > in property values are serialized as < / >. This is valid JSON-LD but cannot be parsed as an HTML tag, neutralizing the break-out vector reported in the advisory (affected: 3.23.1 through 4.0.1).

Thanks to @hacklian for reporting (#243) and supplying the backport patch.

Full Changelog: https://github.com/spatie/schema-org/compare/3.23.1...3.23.2

What's Changed

• Unescape slashes in output by @patrickomeara in #223
• Update graham-campbell/analyzer by @freekmurze in #224
• Upgrade to schema.org v28.1 by @Soean in #222

New Contributors

• @patrickomeara made their first contribution in #223
• @Soean made their first contribution in #222

Full Changelog: 3.23.0...3.23.1

What's Changed

• Unescape slashes in output by @patrickomeara in https://github.com/spatie/schema-org/pull/223
• Update graham-campbell/analyzer by @freekmurze in https://github.com/spatie/schema-org/pull/224
• Upgrade to schema.org v28.1 by @Soean in https://github.com/spatie/schema-org/pull/222

New Contributors

• @patrickomeara made their first contribution in https://github.com/spatie/schema-org/pull/223
• @Soean made their first contribution in https://github.com/spatie/schema-org/pull/222

Full Changelog: https://github.com/spatie/schema-org/compare/3.23.0...3.23.1

What's Changed

• Update generator to use schema v24 by @indyjonesnl in #201
• Schema 24 by @Gummibeer in #213

New Contributors

• @indyjonesnl made their first contribution in #201

Full Changelog: 3.22.0...3.23.0

What's Changed

• Update generator to use schema v24 by @indyjonesnl in https://github.com/spatie/schema-org/pull/201
• Schema 24 by @Gummibeer in https://github.com/spatie/schema-org/pull/213

New Contributors

• @indyjonesnl made their first contribution in https://github.com/spatie/schema-org/pull/201

Full Changelog: https://github.com/spatie/schema-org/compare/3.22.0...3.23.0

What's Changed

• upgrade to schema.org v23 by @Gummibeer in #212

Full Changelog: 3.21.0...3.22.0

What's Changed

• upgrade to schema.org v23 by @Gummibeer in https://github.com/spatie/schema-org/pull/212

Full Changelog: https://github.com/spatie/schema-org/compare/3.21.0...3.22.0

What's Changed

• upgrade to schema.org v22 by @Gummibeer in #211

Full Changelog: 3.20.0...3.21.0

What's Changed

• upgrade to schema.org v22 by @Gummibeer in https://github.com/spatie/schema-org/pull/211

Full Changelog: https://github.com/spatie/schema-org/compare/3.20.0...3.21.0

What's Changed

• upgrade to schema.org v21 by @Gummibeer in #210

Full Changelog: 3.19.0...3.20.0

What's Changed

• upgrade to schema.org v21 by @Gummibeer in https://github.com/spatie/schema-org/pull/210

Full Changelog: https://github.com/spatie/schema-org/compare/3.19.0...3.20.0

What's Changed

• upgrade to schema.org v20 by @Gummibeer in https://github.com/spatie/schema-org/pull/209

Full Changelog: https://github.com/spatie/schema-org/compare/3.18.0...3.19.0

What's Changed

• upgrade to schema.org v19 by @Gummibeer in https://github.com/spatie/schema-org/pull/208

Full Changelog: https://github.com/spatie/schema-org/compare/3.17.0...3.18.0

What's Changed

• upgrade to schema.org v18 by @Gummibeer in https://github.com/spatie/schema-org/pull/207

Full Changelog: https://github.com/spatie/schema-org/compare/3.16.0...3.17.0

What's Changed

• upgrade to schema.org v17 by @Gummibeer in https://github.com/spatie/schema-org/pull/206

Full Changelog: https://github.com/spatie/schema-org/compare/3.15.0...3.16.0

What's Changed

• upgrade to schema.org v16 by @Gummibeer in https://github.com/spatie/schema-org/pull/204
• add support/test-run for php8.3 by @Gummibeer in https://github.com/spatie/schema-org/pull/205

Full Changelog: https://github.com/spatie/schema-org/compare/3.14.0...3.15.0

What's Changed

• Add PHP 8.2 Support by @patinthehat in https://github.com/spatie/schema-org/pull/190
• Add support for nonce attribute by @smortexa in https://github.com/spatie/schema-org/pull/191

New Contributors

• @patinthehat made their first contribution in https://github.com/spatie/schema-org/pull/190
• @smortexa made their first contribution in https://github.com/spatie/schema-org/pull/191

Full Changelog: https://github.com/spatie/schema-org/compare/3.13.0...3.14.0

What's Changed

• add support for complex context by @Gummibeer in https://github.com/spatie/schema-org/pull/189

Full Changelog: https://github.com/spatie/schema-org/compare/3.12.0...3.13.0

What's Changed

• Update generator to use schema v15 by @osopolar in https://github.com/spatie/schema-org/pull/188

New Contributors

• @osopolar made their first contribution in https://github.com/spatie/schema-org/pull/188

Full Changelog: https://github.com/spatie/schema-org/compare/3.11.0...3.12.0

• Drop PHP 7.4 Support - #174
• Add PHP 8.1 Support - #174

• Add support for Laravel 9 - #176

• Upgrade to schema.org:v13.0 - #167

• Upgrade to schema.org:v12.0 - #170

• Upgrade to schema.org:v11.01 - #169

• Upgrade to schema.org:v10 - #166
• Drop PHP 7.3 support - #165
• Add PHP 8.1 support - #165

• Add custom \Spatie\SchemaOrg\Graph context support - #160

• Fix @id and identifier serialization for typed identifiers - #157

• Add PHP 8.0 support

• Add \Spatie\SchemaOrg\ReferencedType to reference types in schemas and graphs - #155

• Fix empty string property values - #153

• Add Multi-Typed-Entity support \Spatie\SchemaOrg\MultiTypedEntity - #148

• Upgrade to schema.org:v9 which includes all extensions

• Upgrade to schema.org:v8

Generated files with new JSON-LD source - some methods have been dropped which aren't part of the corresponding types but were listed in old RDFa - it's not a breaking release because of the same schema.org version and changes only because of schema file inconsistencies.

• Fix \BadMethodCallException message thrown in \Spatie\SchemaOrg\Graph
• Fix \Spatie\SchemaOrg\Graph docblock @method annotations

• Add identifiers to \Spatie\SchemaOrg\Graph nodes #124

• RDFa update

• Fix after malformed RDFa import twitter.com/ScreamingDev

• RDFa update

• Fix types to implement their own contract

• Use contracts as type-hints in doc-blocks

• Add PHP 7.4 support
• Fix Graph magic call
• RDFa update

• Drop PHP 7.2 support

• Drop PHP 7.1 support

• Drop PHP 7.0 support

• Fix identifier serialization

• Add reflection support

• RDFa update

• Fix null values

• Fix pending Types

• RDFa update

• Add Graph support

• Convert invalid objects that have a __toString method to strings

• Fix previous release

• Use https protocol for Schema.org links

• Supports multiple type inheritance. Types no longer extend each other, they all are a direct extension of BaseType
• This release probably doesn't contain any breaking changes for most people. It breaks all type checks (e.g. instanceof LocalBusiness), but doesn't change the way types are generated

• Regenerated types

• Added: Enumeration child types with constants, e.g. Spatie\Schema\DayOfWeek::Monday.

• Added: All types are now json serializable and have array access

• Fixed: Date format in schemas is now ISO8601 (DateTime::ATOM)