@mochabug/adapt-plugin-toolkit
Version:
The API toolkit to facilitate mochabug adapt plugin development
339 lines • 11.7 kB
TypeScript
import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
import type { SignalData, SignalDataJson } from "../../graph/signal_data_pb";
import type { ExchangeOperation, ExchangeOperationJson } from "./runtime_pb";
import type { Message } from "@bufbuild/protobuf";
/**
* Describes the file mochabugapis/adapt/runtime/v1/incoming.proto.
*/
export declare const file_mochabugapis_adapt_runtime_v1_incoming: GenFile;
/**
* Some information about the host environment
* Can for example be used to automatically register hooks for external triggers
*
* @generated from message mochabugapis.adapt.runtime.v1.HostingDetails
*/
export type HostingDetails = Message<"mochabugapis.adapt.runtime.v1.HostingDetails"> & {
/**
* The public host (i.e. domain without protocol) of the host environment
* Only set for public vertices like external triggers and browsers
*
* @generated from field: optional string public_host = 1;
*/
publicHost?: string;
};
/**
* Some information about the host environment
* Can for example be used to automatically register hooks for external triggers
*
* @generated from message mochabugapis.adapt.runtime.v1.HostingDetails
*/
export type HostingDetailsJson = {
/**
* The public host (i.e. domain without protocol) of the host environment
* Only set for public vertices like external triggers and browsers
*
* @generated from field: optional string public_host = 1;
*/
publicHost?: string;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.HostingDetails.
* Use `create(HostingDetailsSchema)` to create a new message.
*/
export declare const HostingDetailsSchema: GenMessage<HostingDetails, {
jsonType: HostingDetailsJson;
}>;
/**
* The request object used to initiate an execution on a specific receiver.
*
* @generated from message mochabugapis.adapt.runtime.v1.StartExecutionRequest
*/
export type StartExecutionRequest = Message<"mochabugapis.adapt.runtime.v1.StartExecutionRequest"> & {
/**
* The name of the receiver to start the execution on.
*
* @generated from field: string receiver = 1;
*/
receiver: string;
/**
* General information about the host environment
*
* @generated from field: mochabugapis.adapt.runtime.v1.HostingDetails host = 2;
*/
host?: HostingDetails;
};
/**
* The request object used to initiate an execution on a specific receiver.
*
* @generated from message mochabugapis.adapt.runtime.v1.StartExecutionRequest
*/
export type StartExecutionRequestJson = {
/**
* The name of the receiver to start the execution on.
*
* @generated from field: string receiver = 1;
*/
receiver?: string;
/**
* General information about the host environment
*
* @generated from field: mochabugapis.adapt.runtime.v1.HostingDetails host = 2;
*/
host?: HostingDetailsJson;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.StartExecutionRequest.
* Use `create(StartExecutionRequestSchema)` to create a new message.
*/
export declare const StartExecutionRequestSchema: GenMessage<StartExecutionRequest, {
jsonType: StartExecutionRequestJson;
}>;
/**
* The response of the start execution
*
* @generated from message mochabugapis.adapt.runtime.v1.StartExecutionResponse
*/
export type StartExecutionResponse = Message<"mochabugapis.adapt.runtime.v1.StartExecutionResponse"> & {};
/**
* The response of the start execution
*
* @generated from message mochabugapis.adapt.runtime.v1.StartExecutionResponse
*/
export type StartExecutionResponseJson = {};
/**
* Describes the message mochabugapis.adapt.runtime.v1.StartExecutionResponse.
* Use `create(StartExecutionResponseSchema)` to create a new message.
*/
export declare const StartExecutionResponseSchema: GenMessage<StartExecutionResponse, {
jsonType: StartExecutionResponseJson;
}>;
/**
* The request object used to stop a currently running execution.
*
* @generated from message mochabugapis.adapt.runtime.v1.StopExecutionRequest
*/
export type StopExecutionRequest = Message<"mochabugapis.adapt.runtime.v1.StopExecutionRequest"> & {
/**
* General information about the host environment
*
* @generated from field: mochabugapis.adapt.runtime.v1.HostingDetails host = 1;
*/
host?: HostingDetails;
};
/**
* The request object used to stop a currently running execution.
*
* @generated from message mochabugapis.adapt.runtime.v1.StopExecutionRequest
*/
export type StopExecutionRequestJson = {
/**
* General information about the host environment
*
* @generated from field: mochabugapis.adapt.runtime.v1.HostingDetails host = 1;
*/
host?: HostingDetailsJson;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.StopExecutionRequest.
* Use `create(StopExecutionRequestSchema)` to create a new message.
*/
export declare const StopExecutionRequestSchema: GenMessage<StopExecutionRequest, {
jsonType: StopExecutionRequestJson;
}>;
/**
* The response of the start execution
*
* @generated from message mochabugapis.adapt.runtime.v1.StopExecutionResponse
*/
export type StopExecutionResponse = Message<"mochabugapis.adapt.runtime.v1.StopExecutionResponse"> & {};
/**
* The response of the start execution
*
* @generated from message mochabugapis.adapt.runtime.v1.StopExecutionResponse
*/
export type StopExecutionResponseJson = {};
/**
* Describes the message mochabugapis.adapt.runtime.v1.StopExecutionResponse.
* Use `create(StopExecutionResponseSchema)` to create a new message.
*/
export declare const StopExecutionResponseSchema: GenMessage<StopExecutionResponse, {
jsonType: StopExecutionResponseJson;
}>;
/**
* The request object used to manage cron-trigger related operations.
*
* @generated from message mochabugapis.adapt.runtime.v1.CronTriggerRequest
*/
export type CronTriggerRequest = Message<"mochabugapis.adapt.runtime.v1.CronTriggerRequest"> & {
/**
* General information about the host environment
*
* @generated from field: mochabugapis.adapt.runtime.v1.HostingDetails host = 1;
*/
host?: HostingDetails;
};
/**
* The request object used to manage cron-trigger related operations.
*
* @generated from message mochabugapis.adapt.runtime.v1.CronTriggerRequest
*/
export type CronTriggerRequestJson = {
/**
* General information about the host environment
*
* @generated from field: mochabugapis.adapt.runtime.v1.HostingDetails host = 1;
*/
host?: HostingDetailsJson;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.CronTriggerRequest.
* Use `create(CronTriggerRequestSchema)` to create a new message.
*/
export declare const CronTriggerRequestSchema: GenMessage<CronTriggerRequest, {
jsonType: CronTriggerRequestJson;
}>;
/**
* The response of the cron-trigger operation
*
* @generated from message mochabugapis.adapt.runtime.v1.CronTriggerResponse
*/
export type CronTriggerResponse = Message<"mochabugapis.adapt.runtime.v1.CronTriggerResponse"> & {};
/**
* The response of the cron-trigger operation
*
* @generated from message mochabugapis.adapt.runtime.v1.CronTriggerResponse
*/
export type CronTriggerResponseJson = {};
/**
* Describes the message mochabugapis.adapt.runtime.v1.CronTriggerResponse.
* Use `create(CronTriggerResponseSchema)` to create a new message.
*/
export declare const CronTriggerResponseSchema: GenMessage<CronTriggerResponse, {
jsonType: CronTriggerResponseJson;
}>;
/**
* The result of executing a exchange
*
* @generated from message mochabugapis.adapt.runtime.v1.ExchangeResult
*/
export type ExchangeResult = Message<"mochabugapis.adapt.runtime.v1.ExchangeResult"> & {
/**
* The name of the transmitter pushing the resulting signals
*
* @generated from field: string transmitter = 1;
*/
transmitter: string;
/**
* The signals to send over the transmitter
*
* @generated from field: map<string, mochabugapis.adapt.graph.SignalData> signals = 2;
*/
signals: {
[key: string]: SignalData;
};
};
/**
* The result of executing a exchange
*
* @generated from message mochabugapis.adapt.runtime.v1.ExchangeResult
*/
export type ExchangeResultJson = {
/**
* The name of the transmitter pushing the resulting signals
*
* @generated from field: string transmitter = 1;
*/
transmitter?: string;
/**
* The signals to send over the transmitter
*
* @generated from field: map<string, mochabugapis.adapt.graph.SignalData> signals = 2;
*/
signals?: {
[key: string]: SignalDataJson;
};
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ExchangeResult.
* Use `create(ExchangeResultSchema)` to create a new message.
*/
export declare const ExchangeResultSchema: GenMessage<ExchangeResult, {
jsonType: ExchangeResultJson;
}>;
/**
* Represents the result object providing detailed information about the exchange operation
*
* @generated from message mochabugapis.adapt.runtime.v1.ExchangeResultRequest
*/
export type ExchangeResultRequest = Message<"mochabugapis.adapt.runtime.v1.ExchangeResultRequest"> & {
/**
* The exchange operation
*
* @generated from field: mochabugapis.adapt.runtime.v1.ExchangeOperation operation = 1;
*/
operation?: ExchangeOperation;
/**
* The result of the exchange, check the operation status before using
*
* @generated from field: mochabugapis.adapt.runtime.v1.ExchangeResult result = 2;
*/
result?: ExchangeResult;
/**
* General information about the host environment
*
* @generated from field: mochabugapis.adapt.runtime.v1.HostingDetails host = 3;
*/
host?: HostingDetails;
};
/**
* Represents the result object providing detailed information about the exchange operation
*
* @generated from message mochabugapis.adapt.runtime.v1.ExchangeResultRequest
*/
export type ExchangeResultRequestJson = {
/**
* The exchange operation
*
* @generated from field: mochabugapis.adapt.runtime.v1.ExchangeOperation operation = 1;
*/
operation?: ExchangeOperationJson;
/**
* The result of the exchange, check the operation status before using
*
* @generated from field: mochabugapis.adapt.runtime.v1.ExchangeResult result = 2;
*/
result?: ExchangeResultJson;
/**
* General information about the host environment
*
* @generated from field: mochabugapis.adapt.runtime.v1.HostingDetails host = 3;
*/
host?: HostingDetailsJson;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ExchangeResultRequest.
* Use `create(ExchangeResultRequestSchema)` to create a new message.
*/
export declare const ExchangeResultRequestSchema: GenMessage<ExchangeResultRequest, {
jsonType: ExchangeResultRequestJson;
}>;
/**
* The response of the procedure result
*
* @generated from message mochabugapis.adapt.runtime.v1.ExchangeResultResponse
*/
export type ExchangeResultResponse = Message<"mochabugapis.adapt.runtime.v1.ExchangeResultResponse"> & {};
/**
* The response of the procedure result
*
* @generated from message mochabugapis.adapt.runtime.v1.ExchangeResultResponse
*/
export type ExchangeResultResponseJson = {};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ExchangeResultResponse.
* Use `create(ExchangeResultResponseSchema)` to create a new message.
*/
export declare const ExchangeResultResponseSchema: GenMessage<ExchangeResultResponse, {
jsonType: ExchangeResultResponseJson;
}>;
//# sourceMappingURL=incoming_pb.d.ts.map