artisan-build / built-for-cloud-contracts
Pure protocol contracts shared by Built for Cloud and Scalpels.
Package info
github.com/artisan-build/built-for-cloud-contracts
pkg:composer/artisan-build/built-for-cloud-contracts
Requires
- php: ^8.4
Requires (Dev)
- laravel/pint: ^1.27
- pestphp/pest: ^4.0
- phpstan/phpstan: ^2.1
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Pure PHP protocol contracts shared by Built for Cloud and Scalpels.
This package is intentionally limited to constants, closed value vocabularies, and pure validators. It does not provide routes, migrations, service providers, models, or runtime services.
Public API
ArtisanBuild\BuiltForCloudContracts\BuiltForCloudexposes the shared protocolAPI_VERSION.ArtisanBuild\BuiltForCloudContracts\Mcp\Classificationdefines the metadata and content classifications.ArtisanBuild\BuiltForCloudContracts\Console\ConsoleKeyringdefines and validates console key identifiers.ArtisanBuild\BuiltForCloudContracts\Console\ConsoleRoledefines the console role vocabulary.ArtisanBuild\BuiltForCloudContracts\Console\AssertionVerifierexposes assertion format and size limits.ArtisanBuild\BuiltForCloudContracts\Console\AssertionPurposedefines assertion purposes.ArtisanBuild\BuiltForCloudContracts\Console\AssertionBurndefines burn retention and pure mint identity hashing.ArtisanBuild\BuiltForCloudContracts\Vitals\VitalsPayloadexposes vitals payload version and numeric bounds.ArtisanBuild\BuiltForCloudContracts\MetadataShapedefines and validates shared metadata string shapes.ArtisanBuild\BuiltForCloudContracts\OwnershipClaimprovides pure ownership-token hashing.
BuiltForCloud::API_VERSION is the shared protocol version. It is separate from the Built for Cloud
package's release version, which remains owned by that package and is not exposed here.
The package contains no persistence, signing, key handling, PASETO parsing, signature verification, payload assembly, framework integration, or other runtime services. Consumers own those behaviors and depend on this package only for the protocol values and pure operations listed above.
Requirements
- PHP 8.4 or later
Installation
composer require artisan-build/built-for-cloud-contracts
Development
composer install
composer test
composer stan
composer lint:test
License
Built for Cloud Contracts is open-sourced software licensed under the MIT license.