Search by

artisan-build / crate-contracts

edgrosvenor

The thin, versioned package contract shared between crate-client and crate-server.

Package info

github.com/artisan-build/crate-contracts

pkg:composer/artisan-build/crate-contracts

Security

Advisories: 0

Aikido package health analysis

Transparency log

Statistics

Installs: 4

Dependents: 2

Suggesters: 0

Stars: 0

v1.0.0 2026-10-13 12:05 UTC

Requires

  • php: ^8.3

Requires (Dev)

Suggests

None

Provides

None

Conflicts

None

Replaces

None

MIT c2b78d3b2b3f13a470bdb7ddaee2c014e127185b

composerregistrylaravelcratecontracts

Published on Packagist.org on 2026-10-13 12:05 UTC

This package is auto-updated.

Last update: 2026-10-13 12:05:48 UTC

README

Framework-free value objects shared by Crate's client and server packages.

This package keeps the wire shapes stable without making either side depend on the other implementation package.

DTOs

  • ArtisanBuild\CrateContracts\ServedRepo: name, url, type, and status for a repository served by Crate.

The repository DTO supports:

  • make(...)
  • toArray()
  • fromArray(...)
  • toJson()
  • fromJson(...)

Invalid payloads throw package exceptions instead of silently accepting malformed data.

Credential wire shapes are owned by artisan-build/built-for-cloud's unified credential store. Crate does not define a second credential DTO or lifecycle. Unified summaries carry stable IDs, kind, purpose, subject, lifecycle, rotation, and presentation metadata; issue and rotation responses carry reveal-once delivery separately.

Enums

  • RepoStatus: pending, building, active, failed, disabled.
  • BuildStatus: queued, running, succeeded, failed.
  • RepoType: vcs, git, path.

Compatibility

Contracts are additive within a major version. Existing fields are not removed or repurposed inside the same major line, so client and server releases can round-trip known payloads safely.