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

package/generated/spine/delivery/admin/admin_service_pb.ts

@@ -0,0 +1,253 @@
+/*
+ * Generated by Spine TypeScript. Do not edit manually.
+ * Source Proto: spine/delivery/admin/admin_service.proto
+ */
+
+
+
+// @generated by protoc-gen-es v2.12.1 with parameter "target=ts,import_extension=js"
+// @generated from file spine/delivery/admin/admin_service.proto (package spine.delivery, syntax proto3)
+/* eslint-disable */
+
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import { enumDesc, fileDesc, messageDesc, serviceDesc } from "@bufbuild/protobuf/codegenv2";
+import { file_spine_options } from "../../options_pb.js";
+import type { EmptySchema, Timestamp } from "@bufbuild/protobuf/wkt";
+import { file_google_protobuf_empty, file_google_protobuf_timestamp } from "@bufbuild/protobuf/wkt";
+import type { ShardIndex } from "../../server/delivery/delivery_pb.js";
+import { file_spine_server_delivery_delivery } from "../../server/delivery/delivery_pb.js";
+import type { Message } from "@bufbuild/protobuf";
+
+/**
+ * Describes the file spine/delivery/admin/admin_service.proto.
+ * Generated from Proto: spine/delivery/admin/admin_service.proto.
+ */
+export const file_spine_delivery_admin_admin_service: GenFile = /*@__PURE__*/
+  fileDesc("CihzcGluZS9kZWxpdmVyeS9hZG1pbi9hZG1pbl9zZXJ2aWNlLnByb3RvEg5zcGluZS5kZWxpdmVyeSJlChRTdWJzY3JpcHRpb25SZXNwb25zZRIRCgdjcmVhdGVkGAEgASgISAASMQoGdXBkYXRlGAIgASgLMh8uc3BpbmUuZGVsaXZlcnkuU2hhcmRJbmZvVXBkYXRlSABCBwoFdmFsdWUizAEKD1NoYXJkSW5mb1VwZGF0ZRI2CgVpbmRleBgBIAEoCzIhLnNwaW5lLnNlcnZlci5kZWxpdmVyeS5TaGFyZEluZGV4QgSghSQBEi8KCm5ld19zdGF0dXMYAiABKA4yGy5zcGluZS5kZWxpdmVyeS5TaGFyZFN0YXR1cxI0ChB3aGVuX2xhc3RfcGlja2VkGAMgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcBIaChJuZXdfbWVzc2FnZXNfY291bnQYBCABKAUiOgoNU2hhcmRJbmZvTGlzdBIpCgZzaGFyZHMYASADKAsyGS5zcGluZS5kZWxpdmVyeS5TaGFyZEluZm8iuQEKCVNoYXJkSW5mbxI2CgVpbmRleBgBIAEoCzIhLnNwaW5lLnNlcnZlci5kZWxpdmVyeS5TaGFyZEluZGV4QgSghSQBEjEKBnN0YXR1cxgCIAEoDjIbLnNwaW5lLmRlbGl2ZXJ5LlNoYXJkU3RhdHVzQgSghSQBEi8KC2xhc3RfcGlja2VkGAMgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcBIQCghtZXNzYWdlcxgEIAEoBSo5CgtTaGFyZFN0YXR1cxIOCgpTU19VTktOT1dOEAASCgoGUElDS0VEEAESDgoKTk9UX1BJQ0tFRBACMrABCgxBZG1pblNlcnZpY2USRQoMR2V0U2hhcmRJbmZvEhYuZ29vZ2xlLnByb3RvYnVmLkVtcHR5Gh0uc3BpbmUuZGVsaXZlcnkuU2hhcmRJbmZvTGlzdBJZChdTdWJzY3JpYmVUb1NoYXJkVXBkYXRlcxIWLmdvb2dsZS5wcm90b2J1Zi5FbXB0eRokLnNwaW5lLmRlbGl2ZXJ5LlN1YnNjcmlwdGlvblJlc3BvbnNlMAFCRwocaW8uc3BpbmUuZGVsaXZlcnkuYWRtaW4uZ3JwY0IRQWRtaW5TZXJ2aWNlUHJvdG9QAaABAaqNJA10eXBlLnNwaW5lLmlvYgZwcm90bzM", [file_spine_options, file_google_protobuf_timestamp, file_google_protobuf_empty, file_spine_server_delivery_delivery]);
+
+/**
+ * An outcome of the subscription to the `ShardInfoUpdate`.
+ *
+ * @generated from message spine.delivery.SubscriptionResponse
+ * Generated from Proto: spine/delivery/admin/admin_service.proto.
+ */
+export type SubscriptionResponse = Message<"spine.delivery.SubscriptionResponse"> & {
+  /**
+   * @generated from oneof spine.delivery.SubscriptionResponse.value
+   */
+  value: {
+    /**
+     * Indicates that the subscription is created.
+     *
+     * @generated from field: bool created = 1;
+     */
+    value: boolean;
+    case: "created";
+  } | {
+    /**
+     * An update of the shard state.
+     *
+     * @generated from field: spine.delivery.ShardInfoUpdate update = 2;
+     */
+    value: ShardInfoUpdate;
+    case: "update";
+  } | { case: undefined; value?: undefined };
+};
+
+/**
+ * Describes the message spine.delivery.SubscriptionResponse.
+ * Use `create(SubscriptionResponseSchema)` to create a new message.
+ * Generated from Proto: spine/delivery/admin/admin_service.proto.
+ */
+export const SubscriptionResponseSchema: GenMessage<SubscriptionResponse> = /*@__PURE__*/
+  messageDesc(file_spine_delivery_admin_admin_service, 0);
+
+/**
+ * An update of the shard info.
+ *
+ * @generated from message spine.delivery.ShardInfoUpdate
+ * Generated from Proto: spine/delivery/admin/admin_service.proto.
+ */
+export type ShardInfoUpdate = Message<"spine.delivery.ShardInfoUpdate"> & {
+  /**
+   * @generated from field: spine.server.delivery.ShardIndex index = 1;
+   */
+  index?: ShardIndex | undefined;
+
+  /**
+   * New status of the shard.
+   *
+   * @generated from field: spine.delivery.ShardStatus new_status = 2;
+   */
+  newStatus: ShardStatus;
+
+  /**
+   * New time when the shard was picked for delivery last time.
+   *
+   * @generated from field: google.protobuf.Timestamp when_last_picked = 3;
+   */
+  whenLastPicked?: Timestamp | undefined;
+
+  /**
+   * New number of messages present in the shard.
+   *
+   * @generated from field: int32 new_messages_count = 4;
+   */
+  newMessagesCount: number;
+};
+
+/**
+ * Describes the message spine.delivery.ShardInfoUpdate.
+ * Use `create(ShardInfoUpdateSchema)` to create a new message.
+ * Generated from Proto: spine/delivery/admin/admin_service.proto.
+ */
+export const ShardInfoUpdateSchema: GenMessage<ShardInfoUpdate> = /*@__PURE__*/
+  messageDesc(file_spine_delivery_admin_admin_service, 1);
+
+/**
+ * A list of `ShardInfo`.
+ *
+ * @generated from message spine.delivery.ShardInfoList
+ * Generated from Proto: spine/delivery/admin/admin_service.proto.
+ */
+export type ShardInfoList = Message<"spine.delivery.ShardInfoList"> & {
+  /**
+   * @generated from field: repeated spine.delivery.ShardInfo shards = 1;
+   */
+  shards: ShardInfo[];
+};
+
+/**
+ * Describes the message spine.delivery.ShardInfoList.
+ * Use `create(ShardInfoListSchema)` to create a new message.
+ * Generated from Proto: spine/delivery/admin/admin_service.proto.
+ */
+export const ShardInfoListSchema: GenMessage<ShardInfoList> = /*@__PURE__*/
+  messageDesc(file_spine_delivery_admin_admin_service, 2);
+
+/**
+ * Information about shard status on the Liquor server.
+ *
+ * @generated from message spine.delivery.ShardInfo
+ * Generated from Proto: spine/delivery/admin/admin_service.proto.
+ */
+export type ShardInfo = Message<"spine.delivery.ShardInfo"> & {
+  /**
+   * Index of the shard.
+   *
+   * @generated from field: spine.server.delivery.ShardIndex index = 1;
+   */
+  index?: ShardIndex | undefined;
+
+  /**
+   * Shows whether the shard picked for delivery or not.
+   *
+   * @generated from field: spine.delivery.ShardStatus status = 2;
+   */
+  status: ShardStatus;
+
+  /**
+   * When the shard was picked for delivery last time.
+   *
+   * Can be unset if the shard has never been picked by workers.
+   *
+   * @generated from field: google.protobuf.Timestamp last_picked = 3;
+   */
+  lastPicked?: Timestamp | undefined;
+
+  /**
+   * Number of messages present in the shard.
+   *
+   * The `(required)` option is not applicable to scalar `int32` fields in the current
+   * Spine validation rules, so it is not set here; `0` is a valid value.
+   *
+   * @generated from field: int32 messages = 4;
+   */
+  messages: number;
+};
+
+/**
+ * Describes the message spine.delivery.ShardInfo.
+ * Use `create(ShardInfoSchema)` to create a new message.
+ * Generated from Proto: spine/delivery/admin/admin_service.proto.
+ */
+export const ShardInfoSchema: GenMessage<ShardInfo> = /*@__PURE__*/
+  messageDesc(file_spine_delivery_admin_admin_service, 3);
+
+/**
+ * Current status of the shard.
+ *
+ * @generated from enum spine.delivery.ShardStatus
+ * Generated from Proto: spine/delivery/admin/admin_service.proto.
+ */
+export enum ShardStatus {
+  /**
+   * @generated from enum value: SS_UNKNOWN = 0;
+   */
+  SS_UNKNOWN = 0,
+
+  /**
+   * Shard is picked for delivery.
+   *
+   * @generated from enum value: PICKED = 1;
+   */
+  PICKED = 1,
+
+  /**
+   * Shard is not picked for delivery.
+   *
+   * @generated from enum value: NOT_PICKED = 2;
+   */
+  NOT_PICKED = 2,
+}
+
+/**
+ * Describes the enum spine.delivery.ShardStatus.
+ * Generated from Proto: spine/delivery/admin/admin_service.proto.
+ */
+export const ShardStatusSchema: GenEnum<ShardStatus> = /*@__PURE__*/
+  enumDesc(file_spine_delivery_admin_admin_service, 0);
+
+/**
+ * Acts as a backend implementation for `AdminService`
+ *
+ * @generated from service spine.delivery.AdminService
+ * Generated from Proto: spine/delivery/admin/admin_service.proto.
+ */
+export const AdminService: GenService<{
+  /**
+   * Gets an information about shards on Liquor server.
+   *
+   * @generated from rpc spine.delivery.AdminService.GetShardInfo
+   */
+  getShardInfo: {
+    methodKind: "unary";
+    input: typeof EmptySchema;
+    output: typeof ShardInfoListSchema;
+  },
+  /**
+   * Subscribes to the updates of shard info.
+   *
+   * The first received `SubscriptionResponse` is an acknowledgement of a successfully created
+   * subscription and contains only the `created` filed set. All other responses contain
+   * `ShardInfoUpdate`. It is guaranteed that the acknowledgement is sent only once as a first
+   * response and never repeated again. Also, it is impossible that any update comes
+   * before the acknowledgement.
+   *
+   * Users should consider the subscription as created only after receiving the acknowledgement
+   * in the `SubscriptionResponse`. All changes in the system occurred before the subscription
+   * acknowledgement is not tracked by this call.
+   *
+   * Each update is sent as a single `ShardInfoUpdate`.
+   *
+   *
+   * @generated from rpc spine.delivery.AdminService.SubscribeToShardUpdates
+   */
+  subscribeToShardUpdates: {
+    methodKind: "server_streaming";
+    input: typeof EmptySchema;
+    output: typeof SubscriptionResponseSchema;
+  },
+}> = /*@__PURE__*/
+  serviceDesc(file_spine_delivery_admin_admin_service, 0);
+

package/generated/spine/delivery/commands_pb.ts

@@ -0,0 +1,219 @@
+/*
+ * Generated by Spine TypeScript. Do not edit manually.
+ * Source Proto: spine/delivery/commands.proto
+ */
+
+
+
+// @generated by protoc-gen-es v2.12.1 with parameter "target=ts,import_extension=js"
+// @generated from file spine/delivery/commands.proto (package spine.delivery, 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 { Duration } from "@bufbuild/protobuf/wkt";
+import { file_google_protobuf_duration } from "@bufbuild/protobuf/wkt";
+import type { InboxMessage } from "../server/delivery/inbox_pb.js";
+import { file_spine_server_delivery_inbox } from "../server/delivery/inbox_pb.js";
+import type { ShardIndex, WorkerId } from "../server/delivery/delivery_pb.js";
+import { file_spine_server_delivery_delivery } from "../server/delivery/delivery_pb.js";
+import type { Message } from "@bufbuild/protobuf";
+
+/**
+ * Describes the file spine/delivery/commands.proto.
+ * Generated from Proto: spine/delivery/commands.proto.
+ */
+export const file_spine_delivery_commands: GenFile = /*@__PURE__*/
+  fileDesc("Ch1zcGluZS9kZWxpdmVyeS9jb21tYW5kcy5wcm90bxIOc3BpbmUuZGVsaXZlcnkidAoMV3JpdGVNZXNzYWdlEjoKB21lc3NhZ2UYASABKAsyIy5zcGluZS5zZXJ2ZXIuZGVsaXZlcnkuSW5ib3hNZXNzYWdlQgSghSQBOijaiyQkCiJpby5zcGluZS5kZWxpdmVyeS5XaXRoSW5ib3hNZXNzYWdlIoMBCg1Xcml0ZU1lc3NhZ2VzEjYKBXNoYXJkGAEgASgLMiEuc3BpbmUuc2VydmVyLmRlbGl2ZXJ5LlNoYXJkSW5kZXhCBKCFJAESOgoHbWVzc2FnZRgCIAMoCzIjLnNwaW5lLnNlcnZlci5kZWxpdmVyeS5JbmJveE1lc3NhZ2VCBKCFJAEidQoNUmVtb3ZlTWVzc2FnZRI6CgdtZXNzYWdlGAEgASgLMiMuc3BpbmUuc2VydmVyLmRlbGl2ZXJ5LkluYm94TWVzc2FnZUIEoIUkAToo2oskJAoiaW8uc3BpbmUuZGVsaXZlcnkuV2l0aEluYm94TWVzc2FnZSKEAQoOUmVtb3ZlTWVzc2FnZXMSNgoFc2hhcmQYASABKAsyIS5zcGluZS5zZXJ2ZXIuZGVsaXZlcnkuU2hhcmRJbmRleEIEoIUkARI6CgdtZXNzYWdlGAIgAygLMiMuc3BpbmUuc2VydmVyLmRlbGl2ZXJ5LkluYm94TWVzc2FnZUIEoIUkASJ8CgtQaWNrVXBTaGFyZBI2CgVzaGFyZBgBIAEoCzIhLnNwaW5lLnNlcnZlci5kZWxpdmVyeS5TaGFyZEluZGV4QgSghSQBEjUKBndvcmtlchgCIAEoCzIfLnNwaW5lLnNlcnZlci5kZWxpdmVyeS5Xb3JrZXJJZEIEoIUkASJ9CgxSZWxlYXNlU2hhcmQSNgoFc2hhcmQYASABKAsyIS5zcGluZS5zZXJ2ZXIuZGVsaXZlcnkuU2hhcmRJbmRleEIEoIUkARI1CgZ3b3JrZXIYAiABKAsyHy5zcGluZS5zZXJ2ZXIuZGVsaXZlcnkuV29ya2VySWRCBKCFJAEiVAoWUmVsZWFzZUV4cGlyZWRTZXNzaW9ucxI6ChFpbmFjdGl2aXR5X3BlcmlvZBgBIAEoCzIZLmdvb2dsZS5wcm90b2J1Zi5EdXJhdGlvbkIEoIUkAUJAChlpby5zcGluZS5kZWxpdmVyeS5jb21tYW5kQg1Db21tYW5kc1Byb3RvUAGgAQGqjSQNdHlwZS5zcGluZS5pb2IGcHJvdG8z", [file_spine_options, file_google_protobuf_duration, file_spine_server_delivery_inbox, file_spine_server_delivery_delivery]);
+
+/**
+ * Writes a new message to the Inbox.
+ *
+ * @generated from message spine.delivery.WriteMessage
+ * Generated from Proto: spine/delivery/commands.proto.
+ */
+export type WriteMessage = Message<"spine.delivery.WriteMessage"> & {
+  /**
+   * The message to be written to the Inbox.
+   *
+   * @generated from field: spine.server.delivery.InboxMessage message = 1;
+   */
+  message?: InboxMessage | undefined;
+};
+
+/**
+ * Describes the message spine.delivery.WriteMessage.
+ * Use `create(WriteMessageSchema)` to create a new message.
+ * Generated from Proto: spine/delivery/commands.proto.
+ */
+export const WriteMessageSchema: GenMessage<WriteMessage> = /*@__PURE__*/
+  messageDesc(file_spine_delivery_commands, 0);
+
+/**
+ * Writes new messages to the Inbox.
+ *
+ * @generated from message spine.delivery.WriteMessages
+ * Generated from Proto: spine/delivery/commands.proto.
+ */
+export type WriteMessages = Message<"spine.delivery.WriteMessages"> & {
+  /**
+   * A shard into which the messages are written.
+   *
+   * @generated from field: spine.server.delivery.ShardIndex shard = 1;
+   */
+  shard?: ShardIndex | undefined;
+
+  /**
+   * The messages to be written to the Inbox.
+   *
+   * @generated from field: repeated spine.server.delivery.InboxMessage message = 2;
+   */
+  message: InboxMessage[];
+};
+
+/**
+ * Describes the message spine.delivery.WriteMessages.
+ * Use `create(WriteMessagesSchema)` to create a new message.
+ * Generated from Proto: spine/delivery/commands.proto.
+ */
+export const WriteMessagesSchema: GenMessage<WriteMessages> = /*@__PURE__*/
+  messageDesc(file_spine_delivery_commands, 1);
+
+/**
+ * Removes a message from the Inbox.
+ *
+ * @generated from message spine.delivery.RemoveMessage
+ * Generated from Proto: spine/delivery/commands.proto.
+ */
+export type RemoveMessage = Message<"spine.delivery.RemoveMessage"> & {
+  /**
+   * The message to be removed from the Inbox.
+   *
+   * @generated from field: spine.server.delivery.InboxMessage message = 1;
+   */
+  message?: InboxMessage | undefined;
+};
+
+/**
+ * Describes the message spine.delivery.RemoveMessage.
+ * Use `create(RemoveMessageSchema)` to create a new message.
+ * Generated from Proto: spine/delivery/commands.proto.
+ */
+export const RemoveMessageSchema: GenMessage<RemoveMessage> = /*@__PURE__*/
+  messageDesc(file_spine_delivery_commands, 2);
+
+/**
+ * Removes messages from the Inbox.
+ *
+ * @generated from message spine.delivery.RemoveMessages
+ * Generated from Proto: spine/delivery/commands.proto.
+ */
+export type RemoveMessages = Message<"spine.delivery.RemoveMessages"> & {
+  /**
+   * A shard from which the messages are removed.
+   *
+   * @generated from field: spine.server.delivery.ShardIndex shard = 1;
+   */
+  shard?: ShardIndex | undefined;
+
+  /**
+   * The messages to be removed from the Inbox.
+   *
+   * @generated from field: repeated spine.server.delivery.InboxMessage message = 2;
+   */
+  message: InboxMessage[];
+};
+
+/**
+ * Describes the message spine.delivery.RemoveMessages.
+ * Use `create(RemoveMessagesSchema)` to create a new message.
+ * Generated from Proto: spine/delivery/commands.proto.
+ */
+export const RemoveMessagesSchema: GenMessage<RemoveMessages> = /*@__PURE__*/
+  messageDesc(file_spine_delivery_commands, 3);
+
+/**
+ * Picks up the shard for processing.
+ *
+ * @generated from message spine.delivery.PickUpShard
+ * Generated from Proto: spine/delivery/commands.proto.
+ */
+export type PickUpShard = Message<"spine.delivery.PickUpShard"> & {
+  /**
+   * The shard to pick up work from.
+   *
+   * @generated from field: spine.server.delivery.ShardIndex shard = 1;
+   */
+  shard?: ShardIndex | undefined;
+
+  /**
+   * The worker that is going to perform the work.
+   *
+   * @generated from field: spine.server.delivery.WorkerId worker = 2;
+   */
+  worker?: WorkerId | undefined;
+};
+
+/**
+ * Describes the message spine.delivery.PickUpShard.
+ * Use `create(PickUpShardSchema)` to create a new message.
+ * Generated from Proto: spine/delivery/commands.proto.
+ */
+export const PickUpShardSchema: GenMessage<PickUpShard> = /*@__PURE__*/
+  messageDesc(file_spine_delivery_commands, 4);
+
+/**
+ * Releases the shard which has been previously picked up.
+ *
+ * @generated from message spine.delivery.ReleaseShard
+ * Generated from Proto: spine/delivery/commands.proto.
+ */
+export type ReleaseShard = Message<"spine.delivery.ReleaseShard"> & {
+  /**
+   * The shard to release.
+   *
+   * @generated from field: spine.server.delivery.ShardIndex shard = 1;
+   */
+  shard?: ShardIndex | undefined;
+
+  /**
+   * The worker that was performing the work.
+   *
+   * @generated from field: spine.server.delivery.WorkerId worker = 2;
+   */
+  worker?: WorkerId | undefined;
+};
+
+/**
+ * Describes the message spine.delivery.ReleaseShard.
+ * Use `create(ReleaseShardSchema)` to create a new message.
+ * Generated from Proto: spine/delivery/commands.proto.
+ */
+export const ReleaseShardSchema: GenMessage<ReleaseShard> = /*@__PURE__*/
+  messageDesc(file_spine_delivery_commands, 5);
+
+/**
+ * Releases the sharded work sessions that were picked up before the configured
+ * inactivity period.
+ *
+ * @generated from message spine.delivery.ReleaseExpiredSessions
+ * Generated from Proto: spine/delivery/commands.proto.
+ */
+export type ReleaseExpiredSessions = Message<"spine.delivery.ReleaseExpiredSessions"> & {
+  /**
+   * The duration of the period after which the shard delivery session is considered expired.
+   *
+   * @generated from field: google.protobuf.Duration inactivity_period = 1;
+   */
+  inactivityPeriod?: Duration | undefined;
+};
+
+/**
+ * Describes the message spine.delivery.ReleaseExpiredSessions.
+ * Use `create(ReleaseExpiredSessionsSchema)` to create a new message.
+ * Generated from Proto: spine/delivery/commands.proto.
+ */
+export const ReleaseExpiredSessionsSchema: GenMessage<ReleaseExpiredSessions> = /*@__PURE__*/
+  messageDesc(file_spine_delivery_commands, 6);
+