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

package/generated/spine/client/command_service_pb.ts

@@ -0,0 +1,60 @@
+/*
+ * Generated by Spine TypeScript. Do not edit manually.
+ * Source Proto: spine/client/command_service.proto
+ */
+
+
+
+// @generated by protoc-gen-es v2.12.1 with parameter "target=ts,import_extension=js"
+// @generated from file spine/client/command_service.proto (package spine.client, syntax proto3)
+/* eslint-disable */
+
+import type { GenFile, GenService } from "@bufbuild/protobuf/codegenv2";
+import { fileDesc, serviceDesc } from "@bufbuild/protobuf/codegenv2";
+import { file_spine_options } from "../options_pb.js";
+import type { CommandSchema } from "../core/command_pb.js";
+import { file_spine_core_command } from "../core/command_pb.js";
+import type { AckSchema } from "../core/ack_pb.js";
+import { file_spine_core_ack } from "../core/ack_pb.js";
+
+/**
+ * Describes the file spine/client/command_service.proto.
+ * Generated from Proto: spine/client/command_service.proto.
+ */
+export const file_spine_client_command_service: GenFile = /*@__PURE__*/
+  fileDesc("CiJzcGluZS9jbGllbnQvY29tbWFuZF9zZXJ2aWNlLnByb3RvEgxzcGluZS5jbGllbnQyPgoOQ29tbWFuZFNlcnZpY2USLAoEUG9zdBITLnNwaW5lLmNvcmUuQ29tbWFuZBoPLnNwaW5lLmNvcmUuQWNrQj4KFGlvLnNwaW5lLmNsaWVudC5ncnBjQhNDb21tYW5kU2VydmljZVByb3RvUAGqjSQNdHlwZS5zcGluZS5pb2IGcHJvdG8z", [file_spine_options, file_spine_core_command, file_spine_core_ack]);
+
+/**
+ * A service for posting commands to the application backend.
+ *
+ * @generated from service spine.client.CommandService
+ * Generated from Proto: spine/client/command_service.proto.
+ */
+export const CommandService: GenService<{
+  /**
+   * Posts the given command to the application backend.
+   *
+   * When the command is successfully received by the application, it responds with
+   * an acknowledgement. The received `Ack` may have one of the following statuses:
+   *
+   *    1. `Status.ok` — the command is accepted for further processing.
+   *    2. `Status.error` — there has been an error receiving the command. No further
+   *        processing would occur.
+   *    3. `Status.rejection` — business rules do not allow the execution of the command.
+   *        E.g., a user who made a request does not have the required permission.
+   *
+   * In case of internal gRPC errors or issues on a transport layer, an `Ack`
+   * would not be received. All errors that occur on the side of gRPC should
+   * be handled by the means of the chosen client stub.
+   *
+   *
+   * @generated from rpc spine.client.CommandService.Post
+   */
+  post: {
+    methodKind: "unary";
+    input: typeof CommandSchema;
+    output: typeof AckSchema;
+  },
+}> = /*@__PURE__*/
+  serviceDesc(file_spine_client_command_service, 0);
+

package/generated/spine/client/entities_pb.ts

@@ -0,0 +1,51 @@
+/*
+ * Generated by Spine TypeScript. Do not edit manually.
+ * Source Proto: spine/client/entities.proto
+ */
+
+
+
+// @generated by protoc-gen-es v2.12.1 with parameter "target=ts,import_extension=js"
+// @generated from file spine/client/entities.proto (package spine.client, 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 { Any } from "@bufbuild/protobuf/wkt";
+import { file_google_protobuf_any } from "@bufbuild/protobuf/wkt";
+import type { Message } from "@bufbuild/protobuf";
+
+/**
+ * Describes the file spine/client/entities.proto.
+ * Generated from Proto: spine/client/entities.proto.
+ */
+export const file_spine_client_entities: GenFile = /*@__PURE__*/
+  fileDesc("ChtzcGluZS9jbGllbnQvZW50aXRpZXMucHJvdG8SDHNwaW5lLmNsaWVudCIsCghFbnRpdHlJZBIgCgJpZBgBIAEoCzIULmdvb2dsZS5wcm90b2J1Zi5BbnlCMwoPaW8uc3BpbmUuY2xpZW50Qg1FbnRpdGllc1Byb3RvUAGqjSQNdHlwZS5zcGluZS5pb2IGcHJvdG8z", [file_spine_options, file_google_protobuf_any]);
+
+/**
+ * Represents an ID of an entity.
+ *
+ * Acts as a read-side API identifier for Projection state, Aggregate state and other entities.
+ *
+ *
+ * @generated from message spine.client.EntityId
+ * Generated from Proto: spine/client/entities.proto.
+ */
+export type EntityId = Message<"spine.client.EntityId"> & {
+  /**
+   * An ID of an entity.
+   *
+   * @generated from field: google.protobuf.Any id = 1;
+   */
+  id?: Any | undefined;
+};
+
+/**
+ * Describes the message spine.client.EntityId.
+ * Use `create(EntityIdSchema)` to create a new message.
+ * Generated from Proto: spine/client/entities.proto.
+ */
+export const EntityIdSchema: GenMessage<EntityId> = /*@__PURE__*/
+  messageDesc(file_spine_client_entities, 0);
+

package/generated/spine/client/filters_pb.ts

@@ -0,0 +1,322 @@
+/*
+ * Generated by Spine TypeScript. Do not edit manually.
+ * Source Proto: spine/client/filters.proto
+ */
+
+
+
+// @generated by protoc-gen-es v2.12.1 with parameter "target=ts,import_extension=js"
+// @generated from file spine/client/filters.proto (package spine.client, 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 type { FieldPath } from "../base/field_path_pb.js";
+import { file_spine_base_field_path } from "../base/field_path_pb.js";
+import type { Message } from "@bufbuild/protobuf";
+
+/**
+ * Describes the file spine/client/filters.proto.
+ * Generated from Proto: spine/client/filters.proto.
+ */
+export const file_spine_client_filters: GenFile = /*@__PURE__*/
+  fileDesc("ChpzcGluZS9jbGllbnQvZmlsdGVycy5wcm90bxIMc3BpbmUuY2xpZW50IpEBCgZUYXJnZXQSEgoEdHlwZRgBIAEoCUIEoIUkARIVCgtpbmNsdWRlX2FsbBgCIAEoCEgAEjQKB2ZpbHRlcnMYAyABKAsyGy5zcGluZS5jbGllbnQuVGFyZ2V0RmlsdGVyc0IE6IUkAUgAOhHaiyQNCgtUYXJnZXRNaXhpbkITCgljcml0ZXJpb24SBqKKJAIIASKLAQoNVGFyZ2V0RmlsdGVycxIvCglpZF9maWx0ZXIYASABKAsyFi5zcGluZS5jbGllbnQuSWRGaWx0ZXJCBOiFJAESMwoGZmlsdGVyGAIgAygLMh0uc3BpbmUuY2xpZW50LkNvbXBvc2l0ZUZpbHRlckIE6IUkAToU8ookEGlkX2ZpbHRlcnxmaWx0ZXIioQIKD0NvbXBvc2l0ZUZpbHRlchIqCgZmaWx0ZXIYASADKAsyFC5zcGluZS5jbGllbnQuRmlsdGVyQgTohSQBEkcKCG9wZXJhdG9yGAIgASgOMi8uc3BpbmUuY2xpZW50LkNvbXBvc2l0ZUZpbHRlci5Db21wb3NpdGVPcGVyYXRvckIEoIUkARI9ChBjb21wb3NpdGVfZmlsdGVyGAMgAygLMh0uc3BpbmUuY2xpZW50LkNvbXBvc2l0ZUZpbHRlckIE6IUkASI+ChFDb21wb3NpdGVPcGVyYXRvchIUChBDQ0ZfQ09fVU5ERUZJTkVEEAASBwoDQUxMEAESCgoGRUlUSEVSEAI6GtqLJBYKFENvbXBvc2l0ZUZpbHRlck1peGluIqICCgZGaWx0ZXISLwoKZmllbGRfcGF0aBgBIAEoCzIVLnNwaW5lLmJhc2UuRmllbGRQYXRoQgSghSQBEikKBXZhbHVlGAIgASgLMhQuZ29vZ2xlLnByb3RvYnVmLkFueUIEoIUkARI1CghvcGVyYXRvchgDIAEoDjIdLnNwaW5lLmNsaWVudC5GaWx0ZXIuT3BlcmF0b3JCBKCFJAEicgoIT3BlcmF0b3ISEQoNQ0ZPX1VOREVGSU5FRBAAEgkKBUVRVUFMEAESEAoMR1JFQVRFUl9USEFOEAISDQoJTEVTU19USEFOEAQSFAoQR1JFQVRFUl9PUl9FUVVBTBAFEhEKDUxFU1NfT1JfRVFVQUwQBjoR2oskDQoLRmlsdGVyTWl4aW4iNgoISWRGaWx0ZXISKgoCaWQYASADKAsyFC5nb29nbGUucHJvdG9idWYuQW55QgighSQB6IUkAUIyCg9pby5zcGluZS5jbGllbnRCDEZpbHRlcnNQcm90b1ABqo0kDXR5cGUuc3BpbmUuaW9iBnByb3RvMw", [file_spine_options, file_google_protobuf_any, file_spine_base_field_path]);
+
+/**
+ * Defines the target type and filters.
+ *
+ * Use `Target` to specify and narrow down the source for `Topic` and `Query` by
+ * the target type and various criteria.
+ *
+ *
+ * @generated from message spine.client.Target
+ * Generated from Proto: spine/client/filters.proto.
+ */
+export type Target = Message<"spine.client.Target"> & {
+  /**
+   * The type of the entity or event of interest.
+   *
+   * Queries support only entity targets while subscriptions work with both event and
+   * entity state types.
+   *
+   *
+   * @generated from field: string type = 1;
+   */
+  type: string;
+
+  /**
+   * The filters that are applied to the received entity state or event message.
+   *
+   * @generated from oneof spine.client.Target.criterion
+   */
+  criterion: {
+    /**
+     * The instruction to include all objects of a given type.
+     *
+     * @generated from field: bool include_all = 2;
+     */
+    value: boolean;
+    case: "includeAll";
+  } | {
+    /**
+     * Filter the objects by a certain criterion.
+     *
+     * Filters must not be empty unless `include_all` is set.
+     *
+     *
+     * @generated from field: spine.client.TargetFilters filters = 3;
+     */
+    value: TargetFilters;
+    case: "filters";
+  } | { case: undefined; value?: undefined };
+};
+
+/**
+ * Describes the message spine.client.Target.
+ * Use `create(TargetSchema)` to create a new message.
+ * Generated from Proto: spine/client/filters.proto.
+ */
+export const TargetSchema: GenMessage<Target> = /*@__PURE__*/
+  messageDesc(file_spine_client_filters, 0);
+
+/**
+ * The set of filters to narrow down the query results/subscription updates.
+ *
+ * @generated from message spine.client.TargetFilters
+ * Generated from Proto: spine/client/filters.proto.
+ */
+export type TargetFilters = Message<"spine.client.TargetFilters"> & {
+  /**
+   * Match objects by their IDs.
+   *
+   * @generated from field: spine.client.IdFilter id_filter = 1;
+   */
+  idFilter?: IdFilter | undefined;
+
+  /**
+   * Match objects by the values of their fields.
+   *
+   * @generated from field: repeated spine.client.CompositeFilter filter = 2;
+   */
+  filter: CompositeFilter[];
+};
+
+/**
+ * Describes the message spine.client.TargetFilters.
+ * Use `create(TargetFiltersSchema)` to create a new message.
+ * Generated from Proto: spine/client/filters.proto.
+ */
+export const TargetFiltersSchema: GenMessage<TargetFilters> = /*@__PURE__*/
+  messageDesc(file_spine_client_filters, 1);
+
+/**
+ * A filter grouping a sub-tree of filters with a specified logical operator.
+ *
+ * May contain both simple filters (i.e. those aimed to match a single field value of the
+ * target object) and composite filters.
+ *
+ * If an instance of `CompositeFilter` has no children, any target object is considered matching.
+ *
+ * @generated from message spine.client.CompositeFilter
+ * Generated from Proto: spine/client/filters.proto.
+ */
+export type CompositeFilter = Message<"spine.client.CompositeFilter"> & {
+  /**
+   * The list of simple filters.
+   *
+   * @generated from field: repeated spine.client.Filter filter = 1;
+   */
+  filter: Filter[];
+
+  /**
+   * The value of the composite operator that determines the behavior of the filter matching.
+   *
+   * @generated from field: spine.client.CompositeFilter.CompositeOperator operator = 2;
+   */
+  operator: CompositeFilter_CompositeOperator;
+
+  /**
+   * The list of child composite filters.
+   *
+   * @generated from field: repeated spine.client.CompositeFilter composite_filter = 3;
+   */
+  compositeFilter: CompositeFilter[];
+};
+
+/**
+ * Describes the message spine.client.CompositeFilter.
+ * Use `create(CompositeFilterSchema)` to create a new message.
+ * Generated from Proto: spine/client/filters.proto.
+ */
+export const CompositeFilterSchema: GenMessage<CompositeFilter> = /*@__PURE__*/
+  messageDesc(file_spine_client_filters, 2);
+
+/**
+ * An enumeration of all supported composite operators upon the filters.
+ *
+ * @generated from enum spine.client.CompositeFilter.CompositeOperator
+ * Generated from Proto: spine/client/filters.proto.
+ */
+export enum CompositeFilter_CompositeOperator {
+  /**
+   * Error value.
+   *
+   * @generated from enum value: CCF_CO_UNDEFINED = 0;
+   */
+  CCF_CO_UNDEFINED = 0,
+
+  /**
+   * The conjunctive operator. The SQL equivalent is `AND`.
+   *
+   * @generated from enum value: ALL = 1;
+   */
+  ALL = 1,
+
+  /**
+   * The disjunctive operator. The SQL equivalent is `OR`.
+   *
+   * @generated from enum value: EITHER = 2;
+   */
+  EITHER = 2,
+}
+
+/**
+ * Describes the enum spine.client.CompositeFilter.CompositeOperator.
+ * Generated from Proto: spine/client/filters.proto.
+ */
+export const CompositeFilter_CompositeOperatorSchema: GenEnum<CompositeFilter_CompositeOperator> = /*@__PURE__*/
+  enumDesc(file_spine_client_filters, 2, 0);
+
+/**
+ * A simple filter matching some value in the event message/entity state.
+ *
+ * @generated from message spine.client.Filter
+ * Generated from Proto: spine/client/filters.proto.
+ */
+export type Filter = Message<"spine.client.Filter"> & {
+  /**
+   * The path to the field to be matched.
+   *
+   * If the filter is an entity query filter, this path must contain a top-level message field
+   * marked with the `(column)` option.
+   *
+   * For subscriptions, any message fields can be specified including the nested fields.
+   *
+   *
+   * @generated from field: spine.base.FieldPath field_path = 1;
+   */
+  fieldPath?: FieldPath | undefined;
+
+  /**
+   * The value to compare upon.
+   *
+   * @generated from field: google.protobuf.Any value = 2;
+   */
+  value?: Any | undefined;
+
+  /**
+   * The comparison operator.
+   *
+   * @generated from field: spine.client.Filter.Operator operator = 3;
+   */
+  operator: Filter_Operator;
+};
+
+/**
+ * Describes the message spine.client.Filter.
+ * Use `create(FilterSchema)` to create a new message.
+ * Generated from Proto: spine/client/filters.proto.
+ */
+export const FilterSchema: GenMessage<Filter> = /*@__PURE__*/
+  messageDesc(file_spine_client_filters, 3);
+
+/**
+ * An enumeration of all supported comparison operators.
+ *
+ * @generated from enum spine.client.Filter.Operator
+ * Generated from Proto: spine/client/filters.proto.
+ */
+export enum Filter_Operator {
+  /**
+   * Error value.
+   *
+   * @generated from enum value: CFO_UNDEFINED = 0;
+   */
+  CFO_UNDEFINED = 0,
+
+  /**
+   * The stored value is equal (`=`) to the passed value.
+   *
+   * @generated from enum value: EQUAL = 1;
+   */
+  EQUAL = 1,
+
+  /**
+   * The stored value is greater than (`>`) the passed value.
+   *
+   * @generated from enum value: GREATER_THAN = 2;
+   */
+  GREATER_THAN = 2,
+
+  /**
+   * The stored value is less than (`<`) the passed value.
+   *
+   * @generated from enum value: LESS_THAN = 4;
+   */
+  LESS_THAN = 4,
+
+  /**
+   * The stored value is greater than or equal to (`>=`) the passed value.
+   *
+   * @generated from enum value: GREATER_OR_EQUAL = 5;
+   */
+  GREATER_OR_EQUAL = 5,
+
+  /**
+   * The stored value is less than or equal to (`<=`) the passed value.
+   *
+   * @generated from enum value: LESS_OR_EQUAL = 6;
+   */
+  LESS_OR_EQUAL = 6,
+}
+
+/**
+ * Describes the enum spine.client.Filter.Operator.
+ * Generated from Proto: spine/client/filters.proto.
+ */
+export const Filter_OperatorSchema: GenEnum<Filter_Operator> = /*@__PURE__*/
+  enumDesc(file_spine_client_filters, 3, 0);
+
+/**
+ * Allows adding an ID filter for the read operations.
+ *
+ * Used to filter out all objects with identifiers not included in the filter.
+ * SQL equivalent is "... where row.id IN (...)".
+ *
+ *
+ * @generated from message spine.client.IdFilter
+ * Generated from Proto: spine/client/filters.proto.
+ */
+export type IdFilter = Message<"spine.client.IdFilter"> & {
+  /**
+   * The collection of IDs.
+   *
+   * Must not be empty.
+   *
+   *
+   * @generated from field: repeated google.protobuf.Any id = 1;
+   */
+  id: Any[];
+};
+
+/**
+ * Describes the message spine.client.IdFilter.
+ * Use `create(IdFilterSchema)` to create a new message.
+ * Generated from Proto: spine/client/filters.proto.
+ */
+export const IdFilterSchema: GenMessage<IdFilter> = /*@__PURE__*/
+  messageDesc(file_spine_client_filters, 4);
+