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

package/generated/spine/client/query_pb.ts

@@ -0,0 +1,345 @@
+/*
+ * Generated by Spine TypeScript. Do not edit manually.
+ * Source Proto: spine/client/query.proto
+ */
+
+
+
+// @generated by protoc-gen-es v2.12.1 with parameter "target=ts,import_extension=js"
+// @generated from file spine/client/query.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, FieldMask } from "@bufbuild/protobuf/wkt";
+import { file_google_protobuf_any, file_google_protobuf_field_mask } from "@bufbuild/protobuf/wkt";
+import { file_spine_core_user_id } from "../core/user_id_pb.js";
+import type { ActorContext } from "../core/actor_context_pb.js";
+import { file_spine_core_actor_context } from "../core/actor_context_pb.js";
+import type { Response } from "../core/response_pb.js";
+import { file_spine_core_response } from "../core/response_pb.js";
+import type { Target } from "./filters_pb.js";
+import { file_spine_client_filters } from "./filters_pb.js";
+import type { Version } from "../core/version_pb.js";
+import { file_spine_core_version } from "../core/version_pb.js";
+import type { Message } from "@bufbuild/protobuf";
+
+/**
+ * Describes the file spine/client/query.proto.
+ * Generated from Proto: spine/client/query.proto.
+ */
+export const file_spine_client_query: GenFile = /*@__PURE__*/
+  fileDesc("ChhzcGluZS9jbGllbnQvcXVlcnkucHJvdG8SDHNwaW5lLmNsaWVudCIYCgdRdWVyeUlkEg0KBXZhbHVlGAEgASgJIpUBCgdPcmRlckJ5EjgKCWRpcmVjdGlvbhgBIAEoDjIfLnNwaW5lLmNsaWVudC5PcmRlckJ5LkRpcmVjdGlvbkIEoIUkARIUCgZjb2x1bW4YAiABKAlCBKCFJAEiOgoJRGlyZWN0aW9uEg4KCk9EX1VOS05PV04QABINCglBU0NFTkRJTkcQARIOCgpERVNDRU5ESU5HEAIi2wEKBVF1ZXJ5EicKAmlkGAEgASgLMhUuc3BpbmUuY2xpZW50LlF1ZXJ5SWRCBKCFJAESLgoGdGFyZ2V0GAIgASgLMhQuc3BpbmUuY2xpZW50LlRhcmdldEIIoIUkAeiFJAESMwoHY29udGV4dBgDIAEoCzIYLnNwaW5lLmNvcmUuQWN0b3JDb250ZXh0QgighSQB6IUkARIyCgZmb3JtYXQYBCABKAsyHC5zcGluZS5jbGllbnQuUmVzcG9uc2VGb3JtYXRCBOiFJAE6ENqLJAwKClF1ZXJ5TWl4aW4ifgoOUmVzcG9uc2VGb3JtYXQSLgoKZmllbGRfbWFzaxgBIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE1hc2sSLQoIb3JkZXJfYnkYAiADKAsyFS5zcGluZS5jbGllbnQuT3JkZXJCeUIE6IUkARINCgVsaW1pdBgDIAEoDSKOAQoNUXVlcnlSZXNwb25zZRIsCghyZXNwb25zZRgBIAEoCzIULnNwaW5lLmNvcmUuUmVzcG9uc2VCBKCFJAESNQoHbWVzc2FnZRgCIAMoCzIkLnNwaW5lLmNsaWVudC5FbnRpdHlTdGF0ZVdpdGhWZXJzaW9uOhjaiyQUChJRdWVyeVJlc3BvbnNlTWl4aW4iYwoWRW50aXR5U3RhdGVXaXRoVmVyc2lvbhIjCgVzdGF0ZRgBIAEoCzIULmdvb2dsZS5wcm90b2J1Zi5BbnkSJAoHdmVyc2lvbhgCIAEoCzITLnNwaW5lLmNvcmUuVmVyc2lvbipfChRRdWVyeVZhbGlkYXRpb25FcnJvchIWChJRVkVfVU5LTk9XTl9SRUFTT04QABIcChhVTlNVUFBPUlRFRF9RVUVSWV9UQVJHRVQQARIRCg1JTlZBTElEX1FVRVJZEAJCMAoPaW8uc3BpbmUuY2xpZW50QgpRdWVyeVByb3RvUAGqjSQNdHlwZS5zcGluZS5pb2IGcHJvdG8z", [file_spine_options, file_google_protobuf_any, file_google_protobuf_field_mask, file_spine_core_user_id, file_spine_core_actor_context, file_spine_core_response, file_spine_client_filters, file_spine_core_version]);
+
+/**
+ * Query identifier.
+ *
+ *
+ * @generated from message spine.client.QueryId
+ * Generated from Proto: spine/client/query.proto.
+ */
+export type QueryId = Message<"spine.client.QueryId"> & {
+  /**
+   * The value of the ID.
+   *
+   * Starts with the `q-` prefix followed by a generated UUID value.
+   *
+   *
+   * @generated from field: string value = 1;
+   */
+  value: string;
+};
+
+/**
+ * Describes the message spine.client.QueryId.
+ * Use `create(QueryIdSchema)` to create a new message.
+ * Generated from Proto: spine/client/query.proto.
+ */
+export const QueryIdSchema: GenMessage<QueryId> = /*@__PURE__*/
+  messageDesc(file_spine_client_query, 0);
+
+/**
+ * An order for query results.
+ *
+ *
+ * @generated from message spine.client.OrderBy
+ * Generated from Proto: spine/client/query.proto.
+ */
+export type OrderBy = Message<"spine.client.OrderBy"> & {
+  /**
+   * A direction of sorting for ordering the Query results.
+   *
+   * @generated from field: spine.client.OrderBy.Direction direction = 1;
+   */
+  direction: OrderBy_Direction;
+
+  /**
+   * A column name whose value is used for ordering the query results. 
+   *
+   * @generated from field: string column = 2;
+   */
+  column: string;
+};
+
+/**
+ * Describes the message spine.client.OrderBy.
+ * Use `create(OrderBySchema)` to create a new message.
+ * Generated from Proto: spine/client/query.proto.
+ */
+export const OrderBySchema: GenMessage<OrderBy> = /*@__PURE__*/
+  messageDesc(file_spine_client_query, 1);
+
+/**
+ * A direction of an `OrderBy` clause specifying if greater or lesser values should come first.
+ *
+ * @generated from enum spine.client.OrderBy.Direction
+ * Generated from Proto: spine/client/query.proto.
+ */
+export enum OrderBy_Direction {
+  /**
+   * Reserved default value.
+   *
+   * @generated from enum value: OD_UNKNOWN = 0;
+   */
+  OD_UNKNOWN = 0,
+
+  /**
+   * An order in which every following value is greater than the previous one.
+   *
+   * For example, collections sorted in an ascending order are `[1, 2, 3]` and 
+   * `["2 cherries", "apple", "apricot", "orange"]`.
+   *
+   * The missing values are placed at the beginning of a collection in an ascending order:
+   * `[null, -2211760924, 0, 943912800]`.
+   *
+   *
+   * @generated from enum value: ASCENDING = 1;
+   */
+  ASCENDING = 1,
+
+  /**
+   * An order in which every following value is lesser than the previous one.
+   *
+   * For example, collections sorted in a descending order are `[2033, 2001, 1984]` and 
+   * `['NaCl', 'N2O', 'H2O2', 'H2O', 'C12H22O11']`.
+   *
+   * The missing values are placed at the end of a collection in a descending order:
+   * `[1905, 1687, -280, null]`.
+   *
+   *
+   * @generated from enum value: DESCENDING = 2;
+   */
+  DESCENDING = 2,
+}
+
+/**
+ * Describes the enum spine.client.OrderBy.Direction.
+ * Generated from Proto: spine/client/query.proto.
+ */
+export const OrderBy_DirectionSchema: GenEnum<OrderBy_Direction> = /*@__PURE__*/
+  enumDesc(file_spine_client_query, 1, 0);
+
+/**
+ * Allows clients to form the requests to the read-side through the `QueryService`.
+ *
+ * `Query` execution typically results in a `QueryResponse` object.
+ *
+ *
+ * @generated from message spine.client.Query
+ * Generated from Proto: spine/client/query.proto.
+ */
+export type Query = Message<"spine.client.Query"> & {
+  /**
+   * The ID of the query.
+   *
+   * @generated from field: spine.client.QueryId id = 1;
+   */
+  id?: QueryId | undefined;
+
+  /**
+   * Defines the entity of interest, e.g. entity type URL and a set of fetch criteria.
+   *
+   * @generated from field: spine.client.Target target = 2;
+   */
+  target?: Target | undefined;
+
+  /**
+   * Service information about the environment in which the query was created.
+   *
+   * @generated from field: spine.core.ActorContext context = 3;
+   */
+  context?: ActorContext | undefined;
+
+  /**
+   * @generated from field: spine.client.ResponseFormat format = 4;
+   */
+  format?: ResponseFormat | undefined;
+};
+
+/**
+ * Describes the message spine.client.Query.
+ * Use `create(QuerySchema)` to create a new message.
+ * Generated from Proto: spine/client/query.proto.
+ */
+export const QuerySchema: GenMessage<Query> = /*@__PURE__*/
+  messageDesc(file_spine_client_query, 2);
+
+/**
+ * A `Query` response format.
+ *
+ * Includes which data should be retrieved, the ordering, and pagination.
+ *
+ *
+ * @generated from message spine.client.ResponseFormat
+ * Generated from Proto: spine/client/query.proto.
+ */
+export type ResponseFormat = Message<"spine.client.ResponseFormat"> & {
+  /**
+   * Field mask to be applied to the items of the query result.
+   *
+   * @generated from field: google.protobuf.FieldMask field_mask = 1;
+   */
+  fieldMask?: FieldMask | undefined;
+
+  /**
+   * An order for entities returned by the Query.
+   *
+   * In case there are several ordering directives, they are applied one-by-one, each following
+   * dealing only with the records considered equal by the previous directive.
+   *
+   * I.e. the first directive is applied to the original set of responses, then the second
+   * directive is used to judge on the order of the records considered to have the same index
+   * of order by the first directive. Same behaviour is expected for each N-th and (N+1)-th of
+   * ordering directives.
+   *
+   *
+   * @generated from field: repeated spine.client.OrderBy order_by = 2;
+   */
+  orderBy: OrderBy[];
+
+  /**
+   * The max number of entities to retrieve.
+   *
+   * If greater than 0, `order_by` should be set as well.
+   *
+   *
+   * @generated from field: uint32 limit = 3;
+   */
+  limit: number;
+};
+
+/**
+ * Describes the message spine.client.ResponseFormat.
+ * Use `create(ResponseFormatSchema)` to create a new message.
+ * Generated from Proto: spine/client/query.proto.
+ */
+export const ResponseFormatSchema: GenMessage<ResponseFormat> = /*@__PURE__*/
+  messageDesc(file_spine_client_query, 3);
+
+/**
+ * The result of `Query` processing.
+ *
+ * Contains the actual processing results and other response attributes.
+ * Used as a result of `QueryService.Read(Query)` gRPC method call.
+ *
+ *
+ * @generated from message spine.client.QueryResponse
+ * Generated from Proto: spine/client/query.proto.
+ */
+export type QueryResponse = Message<"spine.client.QueryResponse"> & {
+  /**
+   * The base status part of the query processing response.
+   *
+   * For example: whether the `Query` has been acked or not.
+   *
+   *
+   * @generated from field: spine.core.Response response = 1;
+   */
+  response?: Response | undefined;
+
+  /**
+   * Entity states and versions returned to the API user as a result of Query execution.
+   *
+   * @generated from field: repeated spine.client.EntityStateWithVersion message = 2;
+   */
+  message: EntityStateWithVersion[];
+};
+
+/**
+ * Describes the message spine.client.QueryResponse.
+ * Use `create(QueryResponseSchema)` to create a new message.
+ * Generated from Proto: spine/client/query.proto.
+ */
+export const QueryResponseSchema: GenMessage<QueryResponse> = /*@__PURE__*/
+  messageDesc(file_spine_client_query, 4);
+
+/**
+ * Represents the entity state combined with entity version.
+ *
+ * This message is a part of Query response.
+ *
+ *
+ * @generated from message spine.client.EntityStateWithVersion
+ * Generated from Proto: spine/client/query.proto.
+ */
+export type EntityStateWithVersion = Message<"spine.client.EntityStateWithVersion"> & {
+  /**
+   * The state of the entity packed as `Any`.
+   *
+   * @generated from field: google.protobuf.Any state = 1;
+   */
+  state?: Any | undefined;
+
+  /**
+   * The version of the entity.
+   *
+   * @generated from field: spine.core.Version version = 2;
+   */
+  version?: Version | undefined;
+};
+
+/**
+ * Describes the message spine.client.EntityStateWithVersion.
+ * Use `create(EntityStateWithVersionSchema)` to create a new message.
+ * Generated from Proto: spine/client/query.proto.
+ */
+export const EntityStateWithVersionSchema: GenMessage<EntityStateWithVersion> = /*@__PURE__*/
+  messageDesc(file_spine_client_query, 5);
+
+/**
+ * Enumeration of possible technical error reasons occurring in query validation.
+ *
+ * @generated from enum spine.client.QueryValidationError
+ * Generated from Proto: spine/client/query.proto.
+ */
+export enum QueryValidationError {
+  /**
+   * Reserved value.
+   *
+   * @generated from enum value: QVE_UNKNOWN_REASON = 0;
+   */
+  QVE_UNKNOWN_REASON = 0,
+
+  /**
+   * The query target is not supported by the server.
+   *
+   * @generated from enum value: UNSUPPORTED_QUERY_TARGET = 1;
+   */
+  UNSUPPORTED_QUERY_TARGET = 1,
+
+  /**
+   * The query message is invalid according to custom Protobuf options set.
+   *
+   * @generated from enum value: INVALID_QUERY = 2;
+   */
+  INVALID_QUERY = 2,
+}
+
+/**
+ * Describes the enum spine.client.QueryValidationError.
+ * Generated from Proto: spine/client/query.proto.
+ */
+export const QueryValidationErrorSchema: GenEnum<QueryValidationError> = /*@__PURE__*/
+  enumDesc(file_spine_client_query, 0);
+

package/generated/spine/client/query_service_pb.ts

@@ -0,0 +1,45 @@
+/*
+ * Generated by Spine TypeScript. Do not edit manually.
+ * Source Proto: spine/client/query_service.proto
+ */
+
+
+
+// @generated by protoc-gen-es v2.12.1 with parameter "target=ts,import_extension=js"
+// @generated from file spine/client/query_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 { QueryResponseSchema, QuerySchema } from "./query_pb.js";
+import { file_spine_client_query } from "./query_pb.js";
+import { file_google_protobuf_type } from "@bufbuild/protobuf/wkt";
+
+/**
+ * Describes the file spine/client/query_service.proto.
+ * Generated from Proto: spine/client/query_service.proto.
+ */
+export const file_spine_client_query_service: GenFile = /*@__PURE__*/
+  fileDesc("CiBzcGluZS9jbGllbnQvcXVlcnlfc2VydmljZS5wcm90bxIMc3BpbmUuY2xpZW50MkgKDFF1ZXJ5U2VydmljZRI4CgRSZWFkEhMuc3BpbmUuY2xpZW50LlF1ZXJ5Ghsuc3BpbmUuY2xpZW50LlF1ZXJ5UmVzcG9uc2VCPAoUaW8uc3BpbmUuY2xpZW50LmdycGNCEVF1ZXJ5U2VydmljZVByb3RvUAGqjSQNdHlwZS5zcGluZS5pb2IGcHJvdG8z", [file_spine_options, file_spine_client_query, file_google_protobuf_type]);
+
+/**
+ * A service for querying the read-side from clients.
+ *
+ * @generated from service spine.client.QueryService
+ * Generated from Proto: spine/client/query_service.proto.
+ */
+export const QueryService: GenService<{
+  /**
+   * Reads certain data from the read-side by setting the criteria via Query.
+   *
+   * @generated from rpc spine.client.QueryService.Read
+   */
+  read: {
+    methodKind: "unary";
+    input: typeof QuerySchema;
+    output: typeof QueryResponseSchema;
+  },
+}> = /*@__PURE__*/
+  serviceDesc(file_spine_client_query_service, 0);
+