Skip to main content

IBlueprintCompilerService

Namespace: Meshmakers.Octo.ConstructionKit.Contracts.BlueprintCatalogs

Service for blueprint compilation and management operations.

public interface IBlueprintCompilerService

Methods​

CreateNewAsync(String, String, String, CancellationToken)​

Creates a new blueprint directory with template files.

Task CreateNewAsync(string path, string blueprintName, string version, CancellationToken cancellationToken)

Parameters​

path String
The path where the blueprint should be created.

blueprintName String
The name of the blueprint.

version String
The version of the blueprint (default: 1.0.0).

cancellationToken CancellationToken
Cancellation token.

Returns​

Task

ValidateAsync(String, OperationResult, CancellationToken)​

Validates a blueprint directory and returns the parsed blueprint metadata.

Task<BlueprintMetaRootDto> ValidateAsync(string path, OperationResult operationResult, CancellationToken cancellationToken)

Parameters​

path String
The path to the blueprint directory.

operationResult OperationResult
The operation result for collecting messages.

cancellationToken CancellationToken
Cancellation token.

Returns​

Task<BlueprintMetaRootDto>
The parsed blueprint metadata.

PackAsync(String, String, OperationResult, CancellationToken)​

Packs a blueprint directory into a distributable archive.

Task<string> PackAsync(string path, string outputPath, OperationResult operationResult, CancellationToken cancellationToken)

Parameters​

path String
The path to the blueprint directory.

outputPath String
The output path for the packed blueprint.

operationResult OperationResult
The operation result for collecting messages.

cancellationToken CancellationToken
Cancellation token.

Returns​

Task<String>
The path to the created archive.