mesh-delivery/modules/mesh-delivery-contracts/ts/seats/nodebuildimage/index.d.ts

// Code generated by seatgen from the seat definitions; DO NOT EDIT.

// The contract of the seat "node-build-image", defined whole (seats/node-build-image/seat.json): The image build module on a node: it takes the asks of the builder and the checker, runs them as steps and answers.

import type * as buildStep from "./parts/build-step.js";

export declare const seat: "node-build-image";

export declare const verbs: {
  readonly current: "current";
  readonly pause: "pause";
  readonly resume: "resume";
  readonly drop: "drop";
  readonly keptArtifact: "kept-artifact";
  readonly steps: "steps";
  readonly output: "output";
};

export declare const accepts: {
  readonly delivery: "delivery";
  readonly check: "check";
  readonly checkStep: "check.step";
  readonly deliveryStep: "delivery.step";
  readonly recheck: "recheck";
};

export declare const events: {
  readonly stepEnded: "step-ended";
  readonly toolchainReported: "toolchain-reported";
  readonly stepProgress: "step-progress";
  readonly askTaken: "ask-taken";
};

export declare const family: { readonly name: "node-build-image.events"; readonly maxAgeDays: 7 };

export declare const stepEndedStream: "SEAT_node-build-image_step-ended";

export declare function stepEndedSubject(node: string): string;

export declare const stepEndedSubjectAll: "mesh.seat.node-build-image.event.step-ended.*";

export declare const toolchainReportedStream: "SEAT_node-build-image_toolchain-reported";

export declare function toolchainReportedSubject(node: string): string;

export declare const toolchainReportedSubjectAll: "mesh.seat.node-build-image.event.toolchain-reported.*";

export declare function stepProgressSubject(node: string): string;

export declare const stepProgressSubjectAll: "mesh.seat.node-build-image.event.step-progress.*";

export declare function askTakenSubject(node: string): string;

export declare const askTakenSubjectAll: "mesh.seat.node-build-image.event.ask-taken.*";

export declare const deliverySubject: "mesh.seat.node-build-image.accept.delivery";

export declare const checkSubject: "mesh.seat.node-build-image.accept.check";

export declare const checkStepSubject: "mesh.seat.node-build-image.accept.check";

export declare const deliveryStepSubject: "mesh.seat.node-build-image.accept.delivery";

export declare const recheckSubject: "mesh.seat.node-build-image.accept.recheck";

export declare const states: {
  readonly steps: "steps";
  readonly pauses: "pauses";
  readonly toolchains: "toolchains";
  readonly detectedSteps: "detected-steps";
};

/** The key of one value of the state steps under the form "<asker>.<node>.<id>". */
export declare function stepsByAskerNodeIDKey(asker: string, node: string, id: string): string;

/** The parts of a key of the form "<asker>.<node>.<id>", or undefined for a key of another form. */
export declare function parseStepsByAskerNodeIDKey(_key: string): { asker: string; node: string; id: string } | undefined;

/** The key of one value of the state steps under the form "<node>.<id>". */
export declare function stepsByNodeIDKey(node: string, id: string): string;

/** The parts of a key of the form "<node>.<id>", or undefined for a key of another form. */
export declare function parseStepsByNodeIDKey(_key: string): { node: string; id: string } | undefined;

/** The key of one value of the state pauses under the form "paused.<node>". */
export declare function pausesByPausedNodeKey(node: string): string;

/** The parts of a key of the form "paused.<node>", or undefined for a key of another form. */
export declare function parsePausesByPausedNodeKey(_key: string): { node: string } | undefined;

/** The key of one value of the state pauses under the form "dropped.<id>". */
export declare function pausesByDroppedIDKey(id: string): string;

/** The parts of a key of the form "dropped.<id>", or undefined for a key of another form. */
export declare function parsePausesByDroppedIDKey(_key: string): { id: string } | undefined;

/** The key of one value of the state pauses under the form "capacity.<node>". */
export declare function pausesByCapacityNodeKey(node: string): string;

/** The parts of a key of the form "capacity.<node>", or undefined for a key of another form. */
export declare function parsePausesByCapacityNodeKey(_key: string): { node: string } | undefined;

/** The key of one value of the state toolchains under the form "<node>.<language>". */
export declare function toolchainsByNodeLanguageKey(node: string, language: string): string;

/** The parts of a key of the form "<node>.<language>", or undefined for a key of another form. */
export declare function parseToolchainsByNodeLanguageKey(_key: string): { node: string; language: string } | undefined;

/** The key of one value of the state detected-steps under the form "<module>.<artifact>". */
export declare function detectedStepsByModuleArtifactKey(module: string, artifact: string): string;

/** The parts of a key of the form "<module>.<artifact>", or undefined for a key of another form. */
export declare function parseDetectedStepsByModuleArtifactKey(_key: string): { module: string; artifact: string } | undefined;

export type AskArtifact = buildStep.AskArtifact;
export type AskTaken = buildStep.AskTaken;
export type AskTakenEvent = buildStep.AskTakenEvent;
export type BuildAnswer = buildStep.BuildAnswer;
export type BuiltArtifact = buildStep.BuiltArtifact;
export type BuiltArtifactResolvedItem = buildStep.BuiltArtifactResolvedItem;
export type Capacity = buildStep.Capacity;
export type CheckAnswer = buildStep.CheckAnswer;
export type ComposeAnswer = buildStep.ComposeAnswer;
export type CurrentAnswer = buildStep.CurrentAnswer;
export type CurrentInput = buildStep.CurrentInput;
export type DetectedStep = buildStep.DetectedStep;
export type DetectedSteps = buildStep.DetectedSteps;
export type Drop = buildStep.Drop;
export type DropAnswer = buildStep.DropAnswer;
export type DropInput = buildStep.DropInput;
export type Fetch = buildStep.Fetch;
export type FetchAnswer = buildStep.FetchAnswer;
export type FetchBesideItem = buildStep.FetchBesideItem;
export type FetchBuildsItem = buildStep.FetchBuildsItem;
export type FetchPackage = buildStep.FetchPackage;
export type FetchRefusal = buildStep.FetchRefusal;
export type KeptArtifactAnswer = buildStep.KeptArtifactAnswer;
export type KeptArtifactInput = buildStep.KeptArtifactInput;
export type KeptResult = buildStep.KeptResult;
export type LevelAnswer = buildStep.LevelAnswer;
export type LevelAnswerDigest = buildStep.LevelAnswerDigest;
export type LevelAnswerDigestNeedsItem = buildStep.LevelAnswerDigestNeedsItem;
export type LevelAnswerDigestPackagesItem = buildStep.LevelAnswerDigestPackagesItem;
export type LevelAnswerKeptItem = buildStep.LevelAnswerKeptItem;
export type LevelAnswerUnmetItem = buildStep.LevelAnswerUnmetItem;
export type ModuleTree = buildStep.ModuleTree;
export type OutputAnswer = buildStep.OutputAnswer;
export type OutputInput = buildStep.OutputInput;
export type Pause = buildStep.Pause;
export type PauseAnswer = buildStep.PauseAnswer;
export type PauseInput = buildStep.PauseInput;
export type PlacedBeside = buildStep.PlacedBeside;
export type Program = buildStep.Program;
export type ResumeAnswer = buildStep.ResumeAnswer;
export type ResumeInput = buildStep.ResumeInput;
export type RunAnswer = buildStep.RunAnswer;
export type RunHead = buildStep.RunHead;
export type RunInput = buildStep.RunInput;
export type RunJob = buildStep.RunJob;
export type RunProgram = buildStep.RunProgram;
export type Step = buildStep.Step;
export type StepAsk = buildStep.StepAsk;
export type StepAskBuild = buildStep.StepAskBuild;
export type StepAskCheck = buildStep.StepAskCheck;
export type StepAskCompose = buildStep.StepAskCompose;
export type StepEnded = buildStep.StepEnded;
export type StepEndedEvent = buildStep.StepEndedEvent;
export type StepProgress = buildStep.StepProgress;
export type StepProgressEvent = buildStep.StepProgressEvent;
export type StepResult = buildStep.StepResult;
export type StepRun = buildStep.StepRun;
export type StepsAnswer = buildStep.StepsAnswer;
export type StepsInput = buildStep.StepsInput;
export type TakenVersion = buildStep.TakenVersion;
export type TestCounts = buildStep.TestCounts;
export type Toolchain = buildStep.Toolchain;
export type ToolchainReported = buildStep.ToolchainReported;
export type ToolchainReportedEvent = buildStep.ToolchainReportedEvent;
export type ToolchainUsed = buildStep.ToolchainUsed;

/** is the body of delivery. */
export type DeliveryAccept = StepAsk;

/** is the body of check. */
export type CheckAccept = StepAsk;

/** is the body of check.step. */
export type CheckStepAccept = StepAsk;

/** is the body of delivery.step. */
export type DeliveryStepAccept = StepAsk;

/** is the body of recheck. */
export type RecheckAccept = StepAsk;

/** is one value of the state steps under the key <asker>.<node>.<id>. */
export type StepsByAskerNodeIDValue = Step;

/** is one value of the state steps under the key <node>.<id>. */
export type StepsByNodeIDValue = Step;

/** is one value of the state pauses under the key paused.<node>. */
export type PausesByPausedNodeValue = Pause;

/** is one value of the state pauses under the key dropped.<id>. */
export type PausesByDroppedIDValue = Drop;

/** is one value of the state pauses under the key capacity.<node>. */
export type PausesByCapacityNodeValue = Capacity;

/** is one value of the state toolchains under the key <node>.<language>. */
export type ToolchainsByNodeLanguageValue = Toolchain;

/** is one value of the state detected-steps under the key <module>.<artifact>. */
export type DetectedStepsByModuleArtifactValue = DetectedSteps;