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

package/proto/spine/client/subscription_record.proto

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2026, CodeMatters. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing permissions and limitations under
+ * the License.
+ */
+syntax = "proto3";
+
+package spine.client;
+
+import "google/protobuf/timestamp.proto";
+import "spine/client/subscription.proto";
+import "spine/options.proto";
+
+option (type_url_prefix) = "type.spine.io";
+option java_multiple_files = true;
+
+// A lifecycle status of a stored subscription.
+enum SubscriptionStatus {
+
+    // An unspecified status.
+    SS_UNSPECIFIED = 0;
+
+    // A subscription that is waiting for activation.
+    PENDING = 1;
+
+    // A subscription that delivers matching updates.
+    ACTIVE = 2;
+}
+
+// A stored definition of one subscription.
+message SubscriptionRecord {
+
+    // The identifier used to store this record.
+    SubscriptionId id = 1 [(required) = true, (validate) = true];
+
+    // The subscription represented by this record.
+    Subscription subscription = 2 [(required) = true, (validate) = true];
+
+    // The current lifecycle status.
+    SubscriptionStatus status = 3 [(required) = true];
+
+    // The time when the subscription was created.
+    google.protobuf.Timestamp when_created = 4 [(required) = true];
+
+    // The deadline for activating a pending subscription.
+    google.protobuf.Timestamp when_activation_expires = 5;
+}

package/proto/spine/client/subscription_service.proto

@@ -0,0 +1,86 @@
+/*
+ * Copyright 2026, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+syntax = "proto3";
+
+package spine.client;
+
+import "spine/options.proto";
+
+option (type_url_prefix) = "type.spine.io";
+option java_package = "io.spine.client.grpc";
+option java_multiple_files = true;
+option java_outer_classname = "SubscriptionServiceProto";
+
+import "spine/client/subscription.proto";
+import "spine/core/response.proto";
+
+// A service for subscribing to receive updates by a specified topic.
+//
+// The subscription topic defines a type in updates of which the client code is interested, and
+// filtering conditions (e.g. by values of fields or identity).
+//
+// Creating a subscription consists of two steps:
+//  * Step 1: creating a `Subscription` instance. This step verifies that the type specified in
+//    the `Topic` is available at the server, and prepares backend structures for delivering
+//    updates. Subscription is created by the `Subscribe(Topic)` call.
+//    together with the contexts of the events.
+//
+//  * Step 2: activating the subscription. This step turns the subscription on.
+//    Activation is performed by the `Activate(Subscription)` call.
+//
+// The client will receive updates until the subscription is cancelled via `Cancel(Subscription)`.
+//
+service SubscriptionService {
+
+    // Creates the subscription to the particular read-side updates.
+    //
+    // Topic defines the target of subscription and other attributes (like field masks).
+    //
+    // NOTE: this method only creates a `Subscription` for the passed `Topic`.
+    // To start listening for updates, please call `Activate(Subscription)`.
+    //
+    rpc Subscribe(Topic) returns (Subscription);
+
+    // Activates the subscription.
+    //
+    // The client will start receiving the updates when 1) an instance of the type specified
+    // in the topic changes and 2) filtering conditions are met. See `spine.client.Target`.
+    //
+    // Cancelled subscriptions cannot be activated. Passing a cancelled subscription will result
+    // in a run-time error.
+    //
+    rpc Activate(Subscription) returns (stream SubscriptionUpdate);
+
+    // Cancels the given subscription.
+    //
+    // Clients will stop receiving the `SubscriptionUpdate` after this method is called.
+    //
+    // The subscription is destroyed as the result of this call. To restore the subscription,
+    // please call `Subscribe(Topic)` and then `Activate(Subscription)` again.
+    //
+    rpc Cancel(Subscription) returns (core.Response);
+}

package/proto/spine/core/ack.proto

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2022, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+syntax = "proto3";
+
+package spine.core;
+
+import "spine/options.proto";
+
+option (type_url_prefix) = "type.spine.io";
+option java_package = "io.spine.core";
+option java_multiple_files = true;
+option java_outer_classname = "BusProto";
+
+import "google/protobuf/any.proto";
+
+import "spine/core/response.proto";
+
+// An acknowledgement of posting a message for asynchronous processing at the server-side.
+//
+// This response means that a message was either accepted for further processing, or rejected
+// (e.g. because of a validation error).
+//
+// The acknowledgement does not mean that the message was handled or even delivered to recipients.
+//
+message Ack {
+
+    // The ID of the message that has been posted.
+    google.protobuf.Any message_id = 1 [(required) = true];
+
+    // The response status.
+    Status status = 2 [(required) = true];
+}

package/proto/spine/core/actor_context.proto

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2022, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+syntax = "proto3";
+
+package spine.core;
+
+import "spine/options.proto";
+
+option (type_url_prefix) = "type.spine.io";
+option java_package = "io.spine.core";
+option java_multiple_files = true;
+option java_outer_classname = "ActorContextProto";
+
+import "google/protobuf/timestamp.proto";
+
+import "spine/core/user_id.proto";
+import "spine/core/tenant_id.proto";
+import "spine/time/time.proto";
+import "spine/ui/language.proto";
+
+// Service metadata for the requests generated by the user.
+message ActorContext {
+
+    // The ID of a tenant in a multi-tenant application.
+    //
+    // This field is not populated in single-tenant applications.
+    //
+    TenantId tenant_id = 1;
+
+    // The user who created the request.
+    UserId actor = 2 [(required) = true];
+
+    // The time when the request was created.
+    google.protobuf.Timestamp timestamp = 3 [(required) = true];
+
+    reserved "zone_offset";
+    reserved 4;
+
+    // The ID of the time-zone from which the request is made.
+    //
+    // Even though this field is not `required` (due to historical reasons),
+    // client applications are strongly encouraged to populate this field to preserve information
+    // for possible time calculations related to the request.
+    //
+    time.ZoneId zone_id = 6;
+
+    // The human language in which the response is expected.
+    //
+    // If this attribute is not defined, or the specified language is not supported
+    // the query will be returned in the default human language of the system.
+    //
+    ui.Language language = 5;
+}

package/proto/spine/core/bounded_context.proto

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2026, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+syntax = "proto3";
+
+package spine.core;
+
+import "spine/options.proto";
+
+option (type_url_prefix) = "type.spine.io";
+option java_package = "io.spine.core";
+option java_multiple_files = true;
+option java_outer_classname = "BoundedContextProto";
+
+// A name of `BoundedContext` used to distinguish an instance of a bounded context among other
+// bounded contexts that exist in the same application.
+//
+// Must be unique in scope of the application.
+//
+message BoundedContextName {
+    option (is).java_type = "BoundedContextNameMixin";
+
+    string value = 1 [(required) = true];
+}

package/proto/spine/core/command.proto

@@ -0,0 +1,170 @@
+/*
+ * Copyright 2026, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+syntax = "proto3";
+
+package spine.core;
+
+import "spine/options.proto";
+
+option (type_url_prefix) = "type.spine.io";
+option java_package = "io.spine.core";
+option java_outer_classname = "CommandProto";
+option java_multiple_files = true;
+
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/any.proto";
+
+import "spine/core/actor_context.proto";
+import "spine/core/diagnostics.proto";
+
+// Command identifier.
+message CommandId {
+    option (is).java_type = "CommandIdMixin";
+    option (SPI_type) = true;
+
+    string uuid = 1;
+}
+
+// `Command` is an instruction to do something.
+//
+// A command consists of two parts: command message and command context.
+//
+// The `message` is the domain model part of the command. The type of the command is defined by
+// the type of its message. When we speak about a 'command' as a typed thing, we refer to
+// the message of the command.
+//
+// The context contains attributes common for all commands.
+//
+// A command can hold any valid Protobuf message, but in most cases, it would be a type
+// defined in the `commands.proto` file of the corresponding aggregate or process manager.
+//
+// There should be one and only one command handler associated with the type of the command.
+//
+message Command {
+    option (is).java_type = "CommandMixin";
+    option (SPI_type) = true;
+
+    // The ID of the command.
+    CommandId id = 1 [(required) = true];
+
+    // The message of the command wrapped into `Any`.
+    google.protobuf.Any message = 2 [(required) = true];
+
+    // Service information about the environment in which the command was created.
+    CommandContext context = 3 [(required) = true];
+
+    // Properties that may be set by the framework as the command is delivered and handled.
+    //
+    // All fields of this type are reserved for internal framework needs, and are not visible to
+    // the business logic code of an application.
+    //
+    message SystemProperties {
+
+        option (internal_type) = true;
+
+        reserved 1 to 10; // for future priority properties.
+
+        // The time when the command was scheduled.
+        //
+        // Set automatically and used only by Spine when re-scheduling a command.
+        //
+        google.protobuf.Timestamp scheduling_time = 11;
+
+        reserved 12 to 20; // for other scheduling-related properties.
+    }
+
+    // Service information used by the framework.
+    SystemProperties system_properties = 4 [(internal) = true];
+}
+
+// Meta-information about the command and the environment, which generated the command.
+message CommandContext {
+    option (is).java_type = "CommandContextMixin";
+    option (SPI_type) = true;
+
+    // Information about the environment of the user who created the command.
+    ActorContext actor_context = 1 [(required) = true];
+
+    // The version of the entity for which this command is intended.
+    //
+    // A client app may not fill in this attribute if the command applies to
+    // any version of the entity.
+    //
+    int32 target_version = 2;
+
+    // Domain-specific attributes of a command.
+    //
+    // One of the usage scenarios for this field is adding attributes common for several commands.
+    //
+    map<string, google.protobuf.Any> attributes = 3;
+
+    // A command may be scheduled. This type defines scheduling options.
+    message Schedule {
+
+        // The delay between the moment of receiving a command at the server
+        // and its delivery to the target.
+        google.protobuf.Duration delay = 1;
+
+        // See: https://github.com/SpineEventEngine/core-java/issues/994
+    }
+
+    // The schedule to execute the command.
+    Schedule schedule = 4;
+
+    Origin origin = 5 [(required) = false, (validate) = true];
+}
+
+// Enumeration of possible errors when validating a command.
+enum CommandValidationError {
+
+    // Reserved value.
+    UNKNOWN = 0;
+
+    // The command type is not supported by the server.
+    UNSUPPORTED_COMMAND = 1;
+
+    // The command message is invalid according to custom Protobuf options set.
+    INVALID_COMMAND = 2;
+
+    // The command context does not have `tenant_id` attribute defined
+    // in a multi-tenant application.
+    TENANT_UNKNOWN = 3;
+
+    // The command context has non-default value of `tenant_id` in the command sent
+    // to a single-tenant application.
+    TENANT_INAPPLICABLE = 4;
+
+    // The scheduled command was not delivered to the target in time.
+    EXPIRED = 5;
+
+    // The command is a duplicate of the command that was already dispatched.
+    //
+    // A command is considered a duplicate if its ID matches the ID of another command.
+    //
+    DUPLICATE_COMMAND = 6;
+}

package/proto/spine/core/diagnostics.proto

@@ -0,0 +1,86 @@
+/*
+ * Copyright 2026, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+syntax = "proto3";
+
+package spine.core;
+
+import "spine/options.proto";
+
+option (type_url_prefix) = "type.spine.io";
+option java_package = "io.spine.core";
+option java_outer_classname = "DiagnosticsProto";
+option java_multiple_files = true;
+
+import "google/protobuf/any.proto";
+
+import "spine/core/actor_context.proto";
+import "spine/core/version.proto";
+
+// An identifier of a domain message, such as a signal, or an entity state.
+message MessageId {
+    option (is).java_type = "io.spine.core.MessageIdMixin";
+
+    // The ID of the message.
+    //
+    // If the message is a signal (an event or a command), `id` has the value of the signal ID (an
+    // `EventId` or a `CommandId`).
+    //
+    // If the message is an entity state, `id` has the value of the entity identifier.
+    //
+    google.protobuf.Any id = 1 [(required) = true, (validate) = true];
+
+    // The type of the message.
+    string type_url = 2 [(required) = true];
+
+    // The version associated with this message.
+    //
+    // If the message is a command, the version is absent.
+    // If the message is an event, this is the `EventContext.version`.
+    // If the message is an entity state, this is the version of the entity.
+    //
+    core.Version version = 3 [(required) = false, (validate) = true];
+}
+
+// An origin of a message.
+//
+// Describes the message chain that led to the associated message being produced.
+//
+message Origin {
+    option (is).java_type = "io.spine.core.OriginMixin";
+
+    // The messageId of the direct parent of the message.
+    MessageId message = 1 [(required) = true, (validate) = true];
+
+    // The origin of the direct parent of the message.
+    Origin grand_origin = 2 [(required) = false, (validate) = true];
+
+    // The actor of the message.
+    //
+    // The actor context is shared among all the messages in the chain.
+    //
+    ActorContext actor_context = 3 [(validate) = true];
+}

package/proto/spine/core/enrichment.proto

@@ -0,0 +1,70 @@
+/*
+ * Copyright 2026, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+syntax = "proto3";
+
+package spine.core;
+
+import "spine/options.proto";
+
+option (type_url_prefix) = "type.spine.io";
+option java_package = "io.spine.core";
+option java_multiple_files = true;
+option java_outer_classname = "EnrichmentProto";
+
+import "google/protobuf/any.proto";
+
+// Attributes with additional information (enrichment) for an outer message.
+//
+// A message can be enriched with one or more messages. For example, an `Event` can be enriched with
+// information for easier building of user interface projections. A `Rejection` can be enriched with
+// additional information on why the command was rejected.
+//
+// If message enrichment should not be performed (e.g. because of performance or security
+// considerations), it can be disabled by setting the `do_not_enrich` attribute to `true`.
+//
+message Enrichment {
+
+    oneof mode {
+
+        // The instruction not to enrich the outer message.
+        bool do_not_enrich = 1;
+
+        // The container for the enrichments.
+        Container container = 2;
+    }
+
+    // A container for event enrichments.
+    //
+    // This wrapper type is required because maps are not allowed in `oneof`s.
+    //
+    message Container {
+
+        // A map from a fully-qualified Protobuf type name of an enrichment,
+        // to its wrapped instance.
+        map<string, google.protobuf.Any> items = 1;
+    }
+}