Class Blueprint

Hierarchy (View Summary)

Contract
- Blueprint

Constructors

constructor

new Blueprint(layout: { [key: string]: any }, skeleton?: any): Blueprint
Parameters
- layout: { [key: string]: any }
  the blueprint layout
- Optionalskeleton: any
  the blueprint skeleton
Returns Blueprint
Name
Blueprint

Memberof
module:contrato
Example
```
const blueprint = new Blueprint({
  'arch.sw': 1,
  'hw.device-type': 1
}, {
  type: 'my-context',
  slug: '{{children.arch.sw.slug}}-{{children.hw.device-type.slug}}'
})
```
Overrides Contract.constructor
- Defined in blueprint.ts:41

Properties

metadata

metadata: any

raw

raw: { type: string } & { [key: string]: any }

Methods

addChild

addChild(contract: Contract, options?: object): this
Function
Parameters
- contract: Contract
  contract
- Optionaloptions: object = {}
  options
Returns this
contract
Name
module:contrato.Contract#addChild
Example
```
const contract = new Contract({ ... })
contract.addChild(new Contract({ ... }))
```
Inherited from Contract.addChild
- Defined in contract.ts:378

addChildren

addChildren(contracts?: Contract[], options?: object): this
Function
Parameters
- contracts: Contract[] = []
  contracts
- Optionaloptions: object = {}
  options
Returns this
contract
Name
module:contrato.Contract#addChildren

Description
This is a utility method over .addChild().
Example
```
const contract = new Contract({ ... })
contract.addChildren([
  new Contract({ ... }),
  new Contract({ ... }),
  new Contract({ ... })
])
```
Inherited from Contract.addChildren
- Defined in contract.ts:474

areChildrenSatisfied

areChildrenSatisfied(options?: { types?: Set<string> }): boolean
Function
Parameters
- Optionaloptions: { types?: Set<string> } = {}
  options
  - Optionaltypes?: Set<string>
    the types to consider (all by default)
Returns boolean
whether the children are satisfied
Name
module:contrato.Contract#areChildrenSatisfied
Example
```
const contract = new Contract({ ... })
contract.addChildren([ ... ])

if (contract.areChildrenSatisfied({
  types: new Set([ 'sw.arch' ])
})) {
  console.log('This contract has all sw.arch requirements satisfied')
}
```
Inherited from Contract.areChildrenSatisfied
- Defined in contract.ts:1300

findChildren

findChildren(matcher: object | Contract): Contract[]

Function

Parameters

matcher: object | Contract
matcher contract

Returns Contract[]

children

Name

module:contrato.Contract#findChildren

Example

const contract = new Contract({ ... })
contract.addChildren([ ... ])

const children = contract.findChildren(Contract.createMatcher({
  type: 'sw.os',
  slug: 'debian'
}))

children.forEach((child) => {
  console.log(child)
})

findChildrenWithCapabilities

findChildrenWithCapabilities(matcher: Contract): Contract[]
Function
Parameters
- matcher: Contract
  matcher contract
Returns Contract[]
children
Name
module:contrato.Contract#findChildren
Example
```
const contract = new Contract({ ... })
contract.addChildren([ ... ])

const children = contract.findChildren(Contract.createMatcher({
  type: 'sw.os',
  slug: 'debian'
}))

children.forEach((child) => {
  console.log(child)
})
```
Inherited from Contract.findChildrenWithCapabilities
- Defined in contract.ts:621

getAllNotSatisfiedChildRequirements

getAllNotSatisfiedChildRequirements(options?: object): any[]
Parameters
- options: object = {}
Returns any[]
Inherited from Contract.getAllNotSatisfiedChildRequirements
- Defined in contract.ts:1329

getAllSlugs

getAllSlugs(): Set<string>

Function

Returns Set<string>

slugs

Name

module:contrato.Contract#getAllSlugs

Example

const contract = new Contract({
  type: 'hw.device-type',
  name: 'Raspberry Pi',
  slug: 'raspberrypi',
  aliases: [ 'rpi', 'raspberry-pi' ]
})

console.log(contract.getAllSlugs())
> Set { raspberrypi, rpi, raspberry-pi }

getCanonicalSlug

getCanonicalSlug(): string
Function
Returns string
slug - contract canonical slug or slug if canonical slug doesn't exist
Name
module:contrato.Contract#getCanonicalSlug
Example
```
const contract = new Contract({
  type: 'arch.sw',
  name: 'armv7hf',
  slug: 'armv7hf'
  canonicalSlug: 'raspberry-pi'
})

console.log(contract.getCanonicalSlug())
```
Inherited from Contract.getCanonicalSlug
- Defined in contract.ts:298

getChildByHash

getChildByHash(childHash: string): Contract | undefined
Function
Parameters
- childHash: string
  child contract hash
Returns Contract | undefined
child
Name
module:contrato.Contract#getChildByHash
Example
```
const contract = new Contract({ ... })
contract.addChildren([ ... ])

const child = contract.getChildByHash('xxxxxxx')

if (child) {
  console.log(child)
}
```
Inherited from Contract.getChildByHash
- Defined in contract.ts:536

getChildren

getChildren(options?: object): Contract[]
Function
Parameters
- Optionaloptions: object = {}
  options
Returns Contract[]
children
Name
module:contrato.Contract#getChildren
Example
```
const contract = new Contract({ ... })
const children = contract.getChildren({
  types: new Set([ 'arch.sw' ])
})

for (const child of children) {
  console.log(child)
}
```
Inherited from Contract.getChildren
- Defined in contract.ts:559

getChildrenByType

getChildrenByType(type: string): Contract[]
Function
Parameters
- type: string
  contract type
Returns Contract[]
children
Name
module:contrato.Contract#getChildrenByType
Example
```
const contract = new Contract({ ... })
contract.addChildren([ ... ])
const children = container.getChildrenByType('sw.os')

children.forEach((child) => {
  console.log(child)
})
```
Inherited from Contract.getChildrenByType
- Defined in contract.ts:590

getChildrenCombinations

getChildrenCombinations(
    options: {
        from: number;
        to: number;
        type: string;
        [index: string]: any;
    },
): Contract[][]

Function

Parameters

options: { from: number; to: number; type: string; [index: string]: any }
options
- [index: string]: any
- from: number
  number of contracts per combination (from)
- to: number
  number of contracts per combination (to)
- type: string
  contract type

Returns Contract[][]

combinations

Name

module:contrato.Contract#getChildrenCombinations

Description

Note that the client is responsible for evaluating that the combination of contracts is valid with regards to requirements, conflicts, etc. This function simply returns all the possible combinations without any further checks.

The combinations output by this function is a plain list of contracts from which you can create a contract, or any other application specific data structure.

Example

const contract = new Contract({ ... })
contract.addChildren([
  new Contract({
    name: 'Debian Wheezy',
    version: 'wheezy',
    slug: 'debian',
    type: 'sw.os'
  }),
  new Contract({
    name: 'Debian Jessie',
    version: 'jessie',
    slug: 'debian',
    type: 'sw.os'
  }),
  new Contract({
    name: 'Fedora 25',
    version: '25',
    slug: 'fedora',
    type: 'sw.os'
  })
])

const combinations = contract.getChildrenCombinations({
  type: 'sw.os',
  from: 2,
  to: 2
})

console.log(combinations)
> [
>   [
>     new Contract({
>       name: 'Debian Wheezy',
>       version: 'wheezy',
>       slug: 'debian',
>       type: 'sw.os'
>     }),
>     new Contract({
>       name: 'Debian Jessie',
>       version: 'jessie',
>       slug: 'debian',
>       type: 'sw.os'
>     })
>   ],
>   [
>     new Contract({
>       name: 'Debian Wheezy',
>       version: 'wheezy',
>       slug: 'debian',
>       type: 'sw.os'
>     }),
>     new Contract({
>       name: 'Fedora 25',
>       version: '25',
>       slug: 'fedora',
>       type: 'sw.os'
>     })
>   ],
>   [
>     new Contract({
>       name: 'Debian Jessie',
>       version: 'jessie',
>       slug: 'debian',
>       type: 'sw.os'
>     }),
>     new Contract({
>       name: 'Fedora 25',
>       version: '25',
>       slug: 'fedora',
>       type: 'sw.os'
>     })
>   ]
> ]

getChildrenCrossReferencedContracts

getChildrenCrossReferencedContracts(
options: { from: Contract; types: Set<string> },
): Contract[]

Function

Parameters

options: { from: Contract; types: Set<string> }
options
- from: Contract
  contract to resolve external contracts from
- types: Set<string>
  types to consider

Returns Contract[]

children cross referenced contracts

Name

module:contrato.Contract#getChildrenCrossReferencedContracts

Example

const contract = new Contract({ ... })

contract.addChildren([
  new Contract({
    type: 'arch.sw',
    slug: 'armv7hf',
    name: 'armv7hf'
  }),
  new Contract({
    type: 'sw.os',
    slug: 'raspbian',
    requires: [
      {
        or: [
          {
            type: 'arch.sw',
            slug: 'armv7hf'
          },
          {
            type: 'arch.sw',
            slug: 'rpi'
          }
        ]
      }
    ]
  }),
  new Contract({
    type: 'sw.stack',
    slug: 'nodejs',
    requires: [
      {
        type: 'arch.sw',
        slug: 'armv7hf'
      }
    ]
  })
])

const references = contract.getChildrenCrossReferencedContracts({
  from: contract,
  types: new Set([ 'arch.sw' ])
})

console.log(references)
> [
>   Contract {
>     type: 'arch.sw',
>     slug: 'armv7hf',
>     name: 'armv7hf'
>   }
> ]

getChildrenTypes

getChildrenTypes(): Set<string>
Function
Returns Set<string>
types
Name
module:contrato.Contract#getChildrenTypes
Example
```
const contract = new Contract({ ... })
contract.addChildren([ { ... }, { ... } ])
console.log(contract.getChildrenTypes())
```
Inherited from Contract.getChildrenTypes
- Defined in contract.ts:508

getNotSatisfiedChildRequirements

getNotSatisfiedChildRequirements(
contract: Contract,
options?: { types?: Set<string> },
): any[]

Function

Parameters

contract: Contract
child contract
Optionaloptions: { types?: Set<string> } = {}
options
- Optionaltypes?: Set<string>
  the types to consider (all by default)

Returns any[]

list of unsatisfied requirements

Name

module:contrato.Contract#satisfiesChildContract

Example

const contract = new Contract({ ... })
contract.addChildren([
  new Contract({
    type: 'sw.os',
    name: 'Debian Wheezy',
    version: 'wheezy',
    slug: 'debian'
  }),
  new Contract({
    type: 'sw.os',
    name: 'Fedora 25',
    version: '25',
    slug: 'fedora'
  })
])

const child = new Contract({
  type: 'sw.stack',
  name: 'Node.js',
  version: '4.8.0',
  slug: 'nodejs',
  requires: [
    {
      or: [
        {
          type: 'sw.os',
          slug: 'debian'
        },
        {
          type: 'sw.os',
          slug: 'fedora'
        }
      ]
    }
  ]
})

if (contract.satisfiesChildContract(child)) {
  console.log('The child contract is satisfied!')
}

getReferencedContracts

getReferencedContracts(
options: { from: Contract; types: Set<string> },
): { [index: string]: Contract[] }
Function
Parameters
- options: { from: Contract; types: Set<string> }
  options
  - from: Contract
    contract to resolve external contracts from
  - types: Set<string>
    types to consider
Returns { [index: string]: Contract[] }
referenced contracts
Name
module:contrato.Contract#getReferencedContracts
Example
```
const universe = new Contract({ ... })
universe.addChildren([ ... ])

const contract = new Contract({ ... })
for (const reference of contract.getReferencedContracts({
  types: new Set([ 'arch.sw' ]),
  from: universe
})) {
  console.log(reference.toJSON())
}
```
Inherited from Contract.getReferencedContracts
- Defined in contract.ts:909

getReferenceString

getReferenceString(): string
Function
Returns string
reference string
Name
module:contrato.Contract#getReferenceString
Example
```
const contract = new Contract({
  type: 'arch.sw',
  name: 'armv7hf',
  slug: 'armv7hf'
})

console.log(contract.getReferenceString())
```
Inherited from Contract.getReferenceString
- Defined in contract.ts:339

getSlug

getSlug(): string
Function
Returns string
slug - contract slug
Name
module:contrato.Contract#getSlug
Example
```
const contract = new Contract({
  type: 'arch.sw',
  name: 'armv7hf',
  slug: 'armv7hf'
})

console.log(contract.getSlug())
```
Inherited from Contract.getSlug
- Defined in contract.ts:230

getType

getType(): string
Function
Returns string
type - contract type
Name
module:contrato.Contract#getType
Example
```
const contract = new Contract({
  type: 'arch.sw',
  name: 'armv7hf',
  slug: 'armv7hf'
})

console.log(contract.getType())
```
Inherited from Contract.getType
- Defined in contract.ts:319

getVersion

getVersion(): string
Function
Returns string
slug - contract version
Name
module:contrato.Contract#getVersion
Example
```
const contract = new Contract({
  type: 'sw.os',
  name: 'Debian Wheezy',
  version: 'wheezy',
  slug: 'debian'
})

console.log(contract.getVersion())
```
Inherited from Contract.getVersion
- Defined in contract.ts:210

hasAliases

hasAliases(): boolean

Function

Returns boolean

whether the contract has aliases

Name

module:contrato.Contract#hasAliases

Example

const contract = new Contract({
  type: 'hw.device-type',
  name: 'Raspberry Pi',
  slug: 'raspberrypi',
  aliases: [ 'rpi', 'raspberry-pi' ]
})

if (contract.hasAliases()) {
  console.log('This contract has aliases')
}

`Protected`hash

hash(): void
Protected Function
Returns void
Name
module:contrato.Contract#hash
Example
```
const contract = new Contract({ ... })
contract.hash()
```
Inherited from Contract.hash
- Defined in contract.ts:86

`Protected`interpolate

interpolate(options?: object): this
Protected Function
Parameters
- Optionaloptions: object = ...
  options
Returns this
contract instance
Name
module:contrato.Contract#interpolate
Example
```
const contract = new Contract({ ... })
contract.interpolate()
```
Inherited from Contract.interpolate
- Defined in contract.ts:176

`Protected`rebuild

rebuild(): void
Protected Function
Returns void
Name
module:contrato.Contract#rebuild
Example
```
const contract = new Contract({ ... })
contract.rebuild()
```
Inherited from Contract.rebuild
- Defined in contract.ts:99

removeChild

removeChild(contract: Contract, options?: object): this
Function
Parameters
- contract: Contract
  contract
- Optionaloptions: object = {}
  options
Returns this
parent contract
Name
module:contrato.Contract#removeChild
Example
```
const contract = new Contract({ ... })

const child = new Contract({ ... })
contract.addChild(child)
contract.removeChild(child)
```
Inherited from Contract.removeChild
- Defined in contract.ts:424

reproduce

reproduce(contract: Contract): IterableIterator<Contract>
Function
Parameters
- contract: Contract
  contract
Returns IterableIterator<Contract>
- an iterable over the valid contexts
Name
module:contrato.Blueprint#reproduce

Description
This method will generate a set of contexts that consist of every possible valid combination that matches the blueprint layout. It uses depth first search to calculate the product of contract combinations and returns the results as an iterable. This allows to reduce the memory usage when dealing with a large universe of contracts.
Example
```
const contract = new Contract({ ... })
contract.addChildren([ ... ])

const blueprint = new Blueprint({
  'hw.device-type': 1,
  'arch.sw': 1
})

const contexts = blueprint.reproduce(contract)
for (const context of contexts) {
  console.log(context.toJSON());
}
```
- Defined in blueprint.ts:120

satisfiesChildContract

satisfiesChildContract(
contract: Contract,
options?: { types?: Set<string> },
): boolean

Function

Parameters

contract: Contract
child contract
Optionaloptions: { types?: Set<string> } = {}
options
- Optionaltypes?: Set<string>
  the types to consider (all by default)

Returns boolean

whether the contract is satisfied

Name

module:contrato.Contract#satisfiesChildContract

Example

const contract = new Contract({ ... })
contract.addChildren([
  new Contract({
    type: 'sw.os',
    name: 'Debian Wheezy',
    version: 'wheezy',
    slug: 'debian'
  }),
  new Contract({
    type: 'sw.os',
    name: 'Fedora 25',
    version: '25',
    slug: 'fedora'
  })
])

const child = new Contract({
  type: 'sw.stack',
  name: 'Node.js',
  version: '4.8.0',
  slug: 'nodejs',
  requires: [
    {
      or: [
        {
          type: 'sw.os',
          slug: 'debian'
        },
        {
          type: 'sw.os',
          slug: 'fedora'
        }
      ]
    }
  ]
})

if (contract.satisfiesChildContract(child)) {
  console.log('The child contract is satisfied!')
}

toJSON

toJSON(): { type: string } & { [key: string]: any }
Function
Returns { type: string } & { [key: string]: any }
JSON object
Name
module:contrato.Contract#toJSON
Example
```
const contract = new Contract({ ... })
const object = contract.toJSON()
console.log(JSON.stringify(object))
```
Inherited from Contract.toJSON
- Defined in contract.ts:357

`Static`build

build(source: { type: string } & { [key: string]: any }): Contract[]

Function

Parameters

source: { type: string } & { [key: string]: any }
source contract

Returns Contract[]

built contracts

Static

Name

module:contrato.Contract.build

Example

const contracts = Contract.build({
  name: 'debian {{version}}',
  slug: 'debian',
  type: 'sw.os',
  variants: [
    { version: 'wheezy' },
    { version: 'jessie' },
    { version: 'sid' }
  ]
})

contracts.forEach((contract) => {
  if (contract instanceof Contract) {
    console.log('This is a built contract')
  }
})

`Protected` `Static`createMatcher

createMatcher(
data: object | object[],
options?: { operation?: string },
): Contract
Protected Function
Parameters
- data: object | object[]
  matcher data
- Optionaloptions: { operation?: string } = {}
  options
  - Optionaloperation?: string
    the matcher's operation
Returns Contract
matcher contract
Static
Name
module:contrato.Contract.createMatcher
Example
```
const matcher = Contract.createMatcher({
  type: 'arch.sw',
  slug: 'armv7hf'
})
```
Inherited from Contract.createMatcher
- Defined in contract.ts:1378

`Static`isEqual

isEqual(contract1: Contract, contract2: Contract): boolean
Function
Parameters
- contract1: Contract
  a contract
- contract2: Contract
  a contract
Returns boolean
whether the contracts are equal
Static
Name
module:contrato.Contract.isEqual
Example
```
const contract1 = new Contract({ ... })
const contract2 = new Contract({ ... })

if (Contract.isEqual(contract1, contract2)) {
  console.log('These contracts are equal')
}
```
Inherited from Contract.isEqual
- Defined in contract.ts:1407

Class Blueprint

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Blueprint

Name

Memberof

Example

Properties

metadata

raw

Methods

addChild

Parameters

Returns this

Name

Example

addChildren

Parameters

Returns this

Name

Description

Example

areChildrenSatisfied

Parameters

Optionaltypes?: Set<string>

Returns boolean

Name

Example

findChildren

Parameters

Returns Contract[]

Name

Example

findChildrenWithCapabilities

Parameters

Returns Contract[]

Name

Example

getAllNotSatisfiedChildRequirements

Parameters

Returns any[]

getAllSlugs

Returns Set<string>

Name

Example

getCanonicalSlug

Returns string

Name

Example

getChildByHash

Parameters

Returns Contract | undefined

Name

Example

getChildren

Parameters

Returns Contract[]

Name

Example

getChildrenByType

Parameters

Returns Contract[]

Name

Example

getChildrenCombinations

Parameters

[index: string]: any

from: number

to: number

type: string

Returns Contract[][]

Name

Description

Example

`Optional`types?: Set<string>

`Optional`types?: Set<string>

`Protected`hash

`Protected`interpolate

`Protected`rebuild