product-os/contrato

The official contracts implementation

contrato's Issues

Allow 'not' or negative operator for device type contracts

ref: balena-os/balena-supervisor#1388

Being able to specify the negation of a requirement would be useful in the supervisor, and likely other users of contrato.

Add support for contract validation

Contrato should expose an isValidContract(c: JSON) function that validates a user supplied contract.

Docs link is broken?

On https://github.com/balena-io/contrato/blob/master/README.md there's a "Documentation" link which points to https://balena-io.github.io/contrato/
When I visit that page, it doesn't contain any documentation itself, but it does have another "Documentation" link which points to https://resin-io-modules.github.io/contrato/ - except when I click on that link I get a 404 error 😕

Use the skhema module to perform any JSON Schema related things

See https://github.com/resin-io-modules/skhema

This will be the common module we will all use to unify both Contrato and Jellyfish. This is a separate module as I want to experiment implementing it as a C++ native add-on in the near future.

Design a way for a container contract to react to changes to its children

For example, given a container contract, we can query its children and get back Contract classes. If we run functions on them, and re-build them, the parent contract doesn’t know about such changes, and re-building the parent contract means that the changes will get discarded because the raw contract tree was never updated.

Design an effective way for contracts to keep track on whether all its templates have been resolved or not

Slugs

A slug is formatted using the loop, type and handle fields of a contract.

If the contract loop and the type loop is null then a slug is formatted with just the type and handle: <type>/<handle>

If the contract loop is not null and the type loop is null then a slug is formatted with all three fields <loop>/<type>/<handle>

If the contract loop is not null and the type loop is not null then the type is prefixed with @ to indicate that the contract and type belong to the loop <loop>/@<type>/<slug>

A slug can only reference a type in the null loop or contract loop. If the type belongs to a different loop than the contract loop the type must be imported. A type can be imported using a type contract that references another type, this has not been fully fleshed out yet.

Open questions

• Should version be part of the slug?
• Should the separator be /?
• Should the @ symbol prefix the type of the whole slug?

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• Update dependency debug to v4
• Update dependency husky to v9
• Update dependency lint-staged to v15
• Update dependency openapi-typescript to v6
• Update dependency rimraf to v5
• Update dependency semver to v7
• Update dependency skhema to v6
• Update dependency ts-node to v10
• Update dependency typescript to v5
• Update js-combinatorics (major) (@types/js-combinatorics, js-combinatorics)
• Update object-hash to v3 (major) (@types/object-hash, object-hash)
• Lock file maintenance
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update dependency js-combinatorics to ^0.6.0
• Update dependency typedoc to ^0.25.0
• Update dependency chai to v5
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

github-actions

.github/workflows/flowzone.yml

• product-os/flowzone master

npm

package.json

• debug ^3.2.6
• handlebars ^4.7.8
• handlebars-async-helpers ^1.0.4
• js-combinatorics ^0.5.5
• lodash ^4.17.19
• object-hash ^1.3.1
• semver ^5.7.1
• skhema ^5.3.2
• @balena/lint ^8.0.2
• @types/chai ^4.2.11
• @types/chai-as-promised ^7.1.2
• @types/debug ^4.1.5
• @types/js-combinatorics ^0.5.32
• @types/lodash ^4.14.168
• @types/mocha ^10.0.6
• @types/node ^20.12.7
• @types/object-hash ^2.1.0
• @types/semver ^7.3.5
• chai ^4.2.0
• chai-as-promised ^7.1.1
• cuelang-js ^1.1.1
• husky ^4.2.5
• lint-staged ^10.1.7
• mocha ^10.4.0
• openapi-typescript ^3.2.4
• rimraf ^3.0.2
• ts-node ^8.10.1
• typedoc ^0.23.28
• typescript ^4.9.5
• node ^20.0.0
• npm ^10.0.0