Download the PHP package artisan-build/hone-contracts without Composer

On this page you can find all versions of the php package artisan-build/hone-contracts. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package hone-contracts

hone-contracts

The versioned wire envelope shared between hone-client (the send side) and hone-server (the receive side) of Hone.

This package is tiny and deliberately so. It is the single place Hone's wire compatibility lives — the DTOs that cross the network, their (de)serialization, and the ENVELOPE_VERSION constant. Both other packages depend on it with a version range.

Read-only mirror. This repository is a read-only split of the artisan-build/hone monorepo. Issues and pull requests are disabled here — please open them on the monorepo.

Why a separate package

Across N independently-deployed senders and one self-hosted receiver, version skew is the normal state, not an error. You cannot keep them in lockstep, so the wire protocol is built to tolerate skew, and the contract that defines it lives in exactly one place that both sides pin.

The compatibility rules

  1. The envelope carries its own version. Every payload includes ENVELOPE_VERSION.
  2. Additive within a major. New fields are optional and added; existing fields are never removed or repurposed. That one rule is what makes a newer server able to parse every older envelope, and an older server able to ignore fields it doesn't recognize.
  3. The inner records are opaque. The envelope wraps Nightwatch record bodies but never interprets them. Only the thin envelope (app id, deploy, batch metadata) is version-sensitive. A change in Nightwatch's payload shape is invisible to this contract.
  4. A major bump is a deliberate act. Crossing an envelope major can only happen through an explicit composer require, never a routine composer update — hone-client pins a caret constraint (^X) on this package.

The envelope (shape)

The envelope wraps a batch of opaque Nightwatch records with the minimum metadata the server needs to route, tag, and version-check them:

Field Meaning
envelope_version The ENVELOPE_VERSION the sender was built against.
app The source application id (one Hone environment may receive many apps).
deploy The deploy identifier — NIGHTWATCH_DEPLOY, typically the commit SHA.
sent_at When the batch was assembled.
records The opaque Nightwatch records; each carries its own type discriminator.

Installation

You usually don't install this directly — it arrives as a dependency of hone-client or hone-server.

License

MIT. See LICENSE.

All versions of hone-contracts with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package artisan-build/hone-contracts contains the following files

Loading the files please wait ...