@spine-event-engine/proto 2.0.0-snapshot.2

package/generated/spine/server/integration/broker_pb.ts

@@ -0,0 +1,183 @@
+/*
+ * Generated by Spine TypeScript. Do not edit manually.
+ * Source Proto: spine/server/integration/broker.proto
+ */
+
+
+
+// @generated by protoc-gen-es v2.12.1 with parameter "target=ts,import_extension=js"
+// @generated from file spine/server/integration/broker.proto (package spine.server.integration, syntax proto3)
+/* eslint-disable */
+
+import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import { enumDesc, fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2";
+import { file_spine_options } from "../../options_pb.js";
+import type { Any } from "@bufbuild/protobuf/wkt";
+import { file_google_protobuf_any } from "@bufbuild/protobuf/wkt";
+import { file_spine_core_actor_context } from "../../core/actor_context_pb.js";
+import type { BoundedContextName } from "../../core/bounded_context_pb.js";
+import { file_spine_core_bounded_context } from "../../core/bounded_context_pb.js";
+import type { Message } from "@bufbuild/protobuf";
+
+/**
+ * Describes the file spine/server/integration/broker.proto.
+ * Generated from Proto: spine/server/integration/broker.proto.
+ */
+export const file_spine_server_integration_broker: GenFile = /*@__PURE__*/
+  fileDesc("CiVzcGluZS9zZXJ2ZXIvaW50ZWdyYXRpb24vYnJva2VyLnByb3RvEhhzcGluZS5zZXJ2ZXIuaW50ZWdyYXRpb24iyAEKD0V4dGVybmFsTWVzc2FnZRImCgJpZBgBIAEoCzIULmdvb2dsZS5wcm90b2J1Zi5BbnlCBKCFJAESNAoQb3JpZ2luYWxfbWVzc2FnZRgCIAEoCzIULmdvb2dsZS5wcm90b2J1Zi5BbnlCBKCFJAESQgoUYm91bmRlZF9jb250ZXh0X25hbWUYBCABKAsyHi5zcGluZS5jb3JlLkJvdW5kZWRDb250ZXh0TmFtZUIEoIUkAUoECAMQBFINYWN0b3JfY29udGV4dCJRChRFeHRlcm5hbEV2ZW50c1dhbnRlZBI5CgR0eXBlGAEgAygLMisuc3BpbmUuc2VydmVyLmludGVncmF0aW9uLkV4dGVybmFsRXZlbnRUeXBlIkkKEUV4dGVybmFsRXZlbnRUeXBlEhYKCHR5cGVfdXJsGAEgASgJQgSghSQBOhzaiyQYChZFeHRlcm5hbEV2ZW50VHlwZU1peGluIk0KFEJvdW5kZWRDb250ZXh0T25saW5lEjUKB2NvbnRleHQYASABKAsyHi5zcGluZS5jb3JlLkJvdW5kZWRDb250ZXh0TmFtZUIEoIUkASpZCh5FeHRlcm5hbE1lc3NhZ2VWYWxpZGF0aW9uRXJyb3ISFQoRRU1fVU5LTk9XTl9SRUFTT04QABIgChxVTlNVUFBPUlRFRF9FWFRFUk5BTF9NRVNTQUdFEAFCPQobaW8uc3BpbmUuc2VydmVyLmludGVncmF0aW9uQgtCcm9rZXJQcm90b1ABqo0kDXR5cGUuc3BpbmUuaW9iBnByb3RvMw", [file_spine_options, file_google_protobuf_any, file_spine_core_actor_context, file_spine_core_bounded_context]);
+
+/**
+ * A wrapper around a message, which is used to send/receive the original message
+ * to/from external application components, such as other Bounded Contexts.
+ *
+ * @generated from message spine.server.integration.ExternalMessage
+ * Generated from Proto: spine/server/integration/broker.proto.
+ */
+export type ExternalMessage = Message<"spine.server.integration.ExternalMessage"> & {
+  /**
+   * An ID of the original message wrapped into `Any` (e.g. an event ID).
+   *
+   * @generated from field: google.protobuf.Any id = 1;
+   */
+  id?: Any | undefined;
+
+  /**
+   * An original message wrapped into `Any` (e.g. a wrapped instance of `io.spine.core.Event`).
+   *
+   * @generated from field: google.protobuf.Any original_message = 2;
+   */
+  originalMessage?: Any | undefined;
+
+  /**
+   * Name of the Bounded Context, within which an original message was created.
+   *
+   * @generated from field: spine.core.BoundedContextName bounded_context_name = 4;
+   */
+  boundedContextName?: BoundedContextName | undefined;
+};
+
+/**
+ * Describes the message spine.server.integration.ExternalMessage.
+ * Use `create(ExternalMessageSchema)` to create a new message.
+ * Generated from Proto: spine/server/integration/broker.proto.
+ */
+export const ExternalMessageSchema: GenMessage<ExternalMessage> = /*@__PURE__*/
+  messageDesc(file_spine_server_integration_broker, 0);
+
+/**
+ * A document message, describing types of events
+ * that are required for consumption by some part of the system.
+ *
+ * One of the typical scenarios is a notification shout-out from the current Bounded Context
+ * to other Bounded Contexts of the application about its `external` subscription needs.
+ *
+ *
+ * @generated from message spine.server.integration.ExternalEventsWanted
+ * Generated from Proto: spine/server/integration/broker.proto.
+ */
+export type ExternalEventsWanted = Message<"spine.server.integration.ExternalEventsWanted"> & {
+  /**
+   * Multiple types may be requested at a time.
+   *
+   * @generated from field: repeated spine.server.integration.ExternalEventType type = 1;
+   */
+  type: ExternalEventType[];
+};
+
+/**
+ * Describes the message spine.server.integration.ExternalEventsWanted.
+ * Use `create(ExternalEventsWantedSchema)` to create a new message.
+ * Generated from Proto: spine/server/integration/broker.proto.
+ */
+export const ExternalEventsWantedSchema: GenMessage<ExternalEventsWanted> = /*@__PURE__*/
+  messageDesc(file_spine_server_integration_broker, 1);
+
+/**
+ * The type of a domain event that is emitted by one Bounded Context and consumed by
+ * other Bounded Contexts as "external" event
+ *
+ * @generated from message spine.server.integration.ExternalEventType
+ * Generated from Proto: spine/server/integration/broker.proto.
+ */
+export type ExternalEventType = Message<"spine.server.integration.ExternalEventType"> & {
+  /**
+   * Type URL of the domain event (e.g. `io.spine.examples.TaskCreated`).
+   *
+   * @generated from field: string type_url = 1;
+   */
+  typeUrl: string;
+};
+
+/**
+ * Describes the message spine.server.integration.ExternalEventType.
+ * Use `create(ExternalEventTypeSchema)` to create a new message.
+ * Generated from Proto: spine/server/integration/broker.proto.
+ */
+export const ExternalEventTypeSchema: GenMessage<ExternalEventType> = /*@__PURE__*/
+  messageDesc(file_spine_server_integration_broker, 2);
+
+/**
+ * Tells that some Bounded Context is connected to the shared transport.
+ *
+ * Used to notify other parties connected to the same transport that the external events they
+ * might need may be provided by the Bounded Context that is online.
+ *
+ * Typically, once others receive this message, they might want to send their
+ * respective `ExternalEventsWanted` messages to see if the connected Bounded Context
+ * is able to provide them.
+ *
+ * Please note this message does not signify that some context has _just_ connected
+ * to the transport. It may be sent by some context that has been using the shared transport
+ * for quite some time — in which case this message may serve to notify just-connected Bounded
+ * Contexts of its existence.
+ *
+ *
+ * @generated from message spine.server.integration.BoundedContextOnline
+ * Generated from Proto: spine/server/integration/broker.proto.
+ */
+export type BoundedContextOnline = Message<"spine.server.integration.BoundedContextOnline"> & {
+  /**
+   * The name of the Bounded Context that is connected to the transport.
+   *
+   * @generated from field: spine.core.BoundedContextName context = 1;
+   */
+  context?: BoundedContextName | undefined;
+};
+
+/**
+ * Describes the message spine.server.integration.BoundedContextOnline.
+ * Use `create(BoundedContextOnlineSchema)` to create a new message.
+ * Generated from Proto: spine/server/integration/broker.proto.
+ */
+export const BoundedContextOnlineSchema: GenMessage<BoundedContextOnline> = /*@__PURE__*/
+  messageDesc(file_spine_server_integration_broker, 3);
+
+/**
+ * The type of error that may occur during the `ExternalMessage` validation.
+ *
+ * @generated from enum spine.server.integration.ExternalMessageValidationError
+ * Generated from Proto: spine/server/integration/broker.proto.
+ */
+export enum ExternalMessageValidationError {
+  /**
+   * Reserved value.
+   *
+   * @generated from enum value: EM_UNKNOWN_REASON = 0;
+   */
+  EM_UNKNOWN_REASON = 0,
+
+  /**
+   * The external message type is not supported by the server.
+   *
+   * @generated from enum value: UNSUPPORTED_EXTERNAL_MESSAGE = 1;
+   */
+  UNSUPPORTED_EXTERNAL_MESSAGE = 1,
+}
+
+/**
+ * Describes the enum spine.server.integration.ExternalMessageValidationError.
+ * Generated from Proto: spine/server/integration/broker.proto.
+ */
+export const ExternalMessageValidationErrorSchema: GenEnum<ExternalMessageValidationError> = /*@__PURE__*/
+  enumDesc(file_spine_server_integration_broker, 0);
+

package/generated/spine/server/server_environment_pb.ts

@@ -0,0 +1,83 @@
+/*
+ * Generated by Spine TypeScript. Do not edit manually.
+ * Source Proto: spine/server/server_environment.proto
+ */
+
+
+
+// @generated by protoc-gen-es v2.12.1 with parameter "target=ts,import_extension=js"
+// @generated from file spine/server/server_environment.proto (package spine.server, syntax proto3)
+/* eslint-disable */
+
+import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import { enumDesc, fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2";
+import { file_spine_options } from "../options_pb.js";
+import type { Message } from "@bufbuild/protobuf";
+
+/**
+ * Describes the file spine/server/server_environment.proto.
+ * Generated from Proto: spine/server/server_environment.proto.
+ */
+export const file_spine_server_server_environment: GenFile = /*@__PURE__*/
+  fileDesc("CiVzcGluZS9zZXJ2ZXIvc2VydmVyX2Vudmlyb25tZW50LnByb3RvEgxzcGluZS5zZXJ2ZXIiHQoGTm9kZUlkEhMKBXZhbHVlGAEgASgJQgSghSQBKk0KDkRlcGxveW1lbnRUeXBlEg4KClNUQU5EQUxPTkUQABIWChJBUFBFTkdJTkVfRU1VTEFUT1IQARITCg9BUFBFTkdJTkVfQ0xPVUQQAkI8Cg9pby5zcGluZS5zZXJ2ZXJCFlNlcnZlckVudmlyb25tZW50UHJvdG9QAaqNJA10eXBlLnNwaW5lLmlvYgZwcm90bzM", [file_spine_options]);
+
+/**
+ * An identifier of a server node of the application.
+ *
+ * @generated from message spine.server.NodeId
+ * Generated from Proto: spine/server/server_environment.proto.
+ */
+export type NodeId = Message<"spine.server.NodeId"> & {
+  /**
+   * @generated from field: string value = 1;
+   */
+  value: string;
+};
+
+/**
+ * Describes the message spine.server.NodeId.
+ * Use `create(NodeIdSchema)` to create a new message.
+ * Generated from Proto: spine/server/server_environment.proto.
+ */
+export const NodeIdSchema: GenMessage<NodeId> = /*@__PURE__*/
+  messageDesc(file_spine_server_server_environment, 0);
+
+/**
+ * A type of the environment system is deployed to.
+ *
+ * @generated from enum spine.server.DeploymentType
+ * Generated from Proto: spine/server/server_environment.proto.
+ */
+export enum DeploymentType {
+  /**
+   * Running in a standalone mode.
+   *
+   * The deployment is considered STANDALONE when no specific runtime is recognized. 
+   *
+   *
+   * @generated from enum value: STANDALONE = 0;
+   */
+  STANDALONE = 0,
+
+  /**
+   * Running on an App Engine local development server.
+   *
+   * @generated from enum value: APPENGINE_EMULATOR = 1;
+   */
+  APPENGINE_EMULATOR = 1,
+
+  /**
+   * Running on an App Engine cloud infrastructure.
+   *
+   * @generated from enum value: APPENGINE_CLOUD = 2;
+   */
+  APPENGINE_CLOUD = 2,
+}
+
+/**
+ * Describes the enum spine.server.DeploymentType.
+ * Generated from Proto: spine/server/server_environment.proto.
+ */
+export const DeploymentTypeSchema: GenEnum<DeploymentType> = /*@__PURE__*/
+  enumDesc(file_spine_server_server_environment, 0);
+

package/generated/spine/server/transport/transport_pb.ts

@@ -0,0 +1,46 @@
+/*
+ * Generated by Spine TypeScript. Do not edit manually.
+ * Source Proto: spine/server/transport/transport.proto
+ */
+
+
+
+// @generated by protoc-gen-es v2.12.1 with parameter "target=ts,import_extension=js"
+// @generated from file spine/server/transport/transport.proto (package spine.server.transport, syntax proto3)
+/* eslint-disable */
+
+import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import { fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2";
+import { file_spine_options } from "../../options_pb.js";
+import type { Message } from "@bufbuild/protobuf";
+
+/**
+ * Describes the file spine/server/transport/transport.proto.
+ * Generated from Proto: spine/server/transport/transport.proto.
+ */
+export const file_spine_server_transport_transport: GenFile = /*@__PURE__*/
+  fileDesc("CiZzcGluZS9zZXJ2ZXIvdHJhbnNwb3J0L3RyYW5zcG9ydC5wcm90bxIWc3BpbmUuc2VydmVyLnRyYW5zcG9ydCIgCglDaGFubmVsSWQSEwoLdGFyZ2V0X3R5cGUYASABKAlCPgoZaW8uc3BpbmUuc2VydmVyLnRyYW5zcG9ydEIOVHJhbnNwb3J0UHJvdG9QAaqNJA10eXBlLnNwaW5lLmlvYgZwcm90bzM", [file_spine_options]);
+
+/**
+ * Identifier of a transport channel.
+ *
+ * @generated from message spine.server.transport.ChannelId
+ * Generated from Proto: spine/server/transport/transport.proto.
+ */
+export type ChannelId = Message<"spine.server.transport.ChannelId"> & {
+  /**
+   * The type URL of the messages transmitted through the channel.
+   *
+   * @generated from field: string target_type = 1;
+   */
+  targetType: string;
+};
+
+/**
+ * Describes the message spine.server.transport.ChannelId.
+ * Use `create(ChannelIdSchema)` to create a new message.
+ * Generated from Proto: spine/server/transport/transport.proto.
+ */
+export const ChannelIdSchema: GenMessage<ChannelId> = /*@__PURE__*/
+  messageDesc(file_spine_server_transport_transport, 0);
+

package/generated/spine/string/template_string_pb.ts

@@ -0,0 +1,78 @@
+/*
+ * Generated by Spine TypeScript. Do not edit manually.
+ * Source Proto: spine/string/template_string.proto
+ */
+
+
+
+// @generated by protoc-gen-es v2.12.1 with parameter "target=ts,import_extension=js"
+// @generated from file spine/string/template_string.proto (package spine.string, syntax proto3)
+/* eslint-disable */
+
+import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import { fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2";
+import { file_spine_options } from "../options_pb.js";
+import type { Message } from "@bufbuild/protobuf";
+
+/**
+ * Describes the file spine/string/template_string.proto.
+ * Generated from Proto: spine/string/template_string.proto.
+ */
+export const file_spine_string_template_string: GenFile = /*@__PURE__*/
+  fileDesc("CiJzcGluZS9zdHJpbmcvdGVtcGxhdGVfc3RyaW5nLnByb3RvEgxzcGluZS5zdHJpbmciswEKDlRlbXBsYXRlU3RyaW5nEhkKEXdpdGhfcGxhY2Vob2xkZXJzGAEgASgJEk0KEXBsYWNlaG9sZGVyX3ZhbHVlGAIgAygLMjIuc3BpbmUuc3RyaW5nLlRlbXBsYXRlU3RyaW5nLlBsYWNlaG9sZGVyVmFsdWVFbnRyeRo3ChVQbGFjZWhvbGRlclZhbHVlRW50cnkSCwoDa2V5GAEgASgJEg0KBXZhbHVlGAIgASgJOgI4AUI5Cg9pby5zcGluZS5zdHJpbmdCE1RlbXBsYXRlU3RyaW5nUHJvdG9QAaqNJA10eXBlLnNwaW5lLmlvYgZwcm90bzM", [file_spine_options]);
+
+/**
+ * Represents a template string with placeholders and a map for further substituting
+ * those placeholders with the actual values.
+ *
+ * Placeholders are specified using the format `${key}`, where `key` is the identifier
+ * for the value to be substituted from the `placeholder_value` map. There are no
+ * expectations about the identifier format. It can be `myKey`, `my.key`, `my_key`, etc.
+ *
+ * Example usage:
+ *     template_string = "My dog's name is ${dog.name}."
+ *     placeholder_values = { "dog.name": "Fido" }
+ *
+ * After substitution, the final output would be:
+ *     "My dog's name is Fido."
+ *
+ * Each placeholder `key` referenced in the template string must have a corresponding entry
+ * in the `placeholder_value` map. However, the `placeholder_value` map is not restricted to
+ * containing only the placeholders used in the template. Additional entries in the map
+ * that do not correspond to placeholders in the template string are permitted.
+ *
+ *
+ * @generated from message spine.string.TemplateString
+ * Generated from Proto: spine/string/template_string.proto.
+ */
+export type TemplateString = Message<"spine.string.TemplateString"> & {
+  /**
+   * The template string that may contain one or more placeholders.
+   *
+   * @generated from field: string with_placeholders = 1;
+   */
+  withPlaceholders: string;
+
+  /**
+   * A map that provides values for placeholders referenced in `with_placeholders`.
+   *
+   * The keys in this map should match the placeholder keys inside `with_placeholders`
+   * excluding the `${}` placeholder markers.
+   *
+   * All placeholders present in `with_placeholders` must have corresponding entries
+   * in this map. Otherwise, the template is considered invalid.
+   *
+   *
+   * @generated from field: map<string, string> placeholder_value = 2;
+   */
+  placeholderValue: { [key: string]: string };
+};
+
+/**
+ * Describes the message spine.string.TemplateString.
+ * Use `create(TemplateStringSchema)` to create a new message.
+ * Generated from Proto: spine/string/template_string.proto.
+ */
+export const TemplateStringSchema: GenMessage<TemplateString> = /*@__PURE__*/
+  messageDesc(file_spine_string_template_string, 0);
+