@raystack/proton 0.1.0-35dd68d487bfa7e7339c40e9b103ee7377aac6e6 → 0.1.0-434b8aec0c95625a6633f4e890be311d3e0fefef

package/raystack/raccoon/v1beta1/raccoon_pb.d.ts

@@ -0,0 +1,268 @@
+// @generated by protoc-gen-es v2.6.2 with parameter "target=ts+js+dts,import_extension=none"
+// @generated from file raystack/raccoon/v1beta1/raccoon.proto (package raystack.raccoon.v1beta1, syntax proto3)
+/* eslint-disable */
+
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+import type { Timestamp } from "@bufbuild/protobuf/wkt";
+
+/**
+ * Describes the file raystack/raccoon/v1beta1/raccoon.proto.
+ */
+export declare const file_raystack_raccoon_v1beta1_raccoon: GenFile;
+
+/**
+ *
+ * `EventRequest` defines the contract to push events to Raccoon
+ *
+ * An `EventRequest` allows you to push more than one events(batch). The events
+ * are wrapped inside `events` repeated field. All of the fields on `EventRequest`
+ * are required.
+ *
+ * @generated from message raystack.raccoon.v1beta1.SendEventRequest
+ */
+export declare type SendEventRequest = Message<"raystack.raccoon.v1beta1.SendEventRequest"> & {
+  /**
+   *
+   * `req_guid` is unique identifier of the request the client is making.
+   *
+   * Raccoon uses the identifier to send response of the request. The client can handle the
+   * response accordingly. For example, the client can retry the request in case the response is
+   * giving `INTERNAL_ERROR` code with "publisher failed" reason.
+   *
+   * This identifier is necessary because on event-based protocols like WebSocket the response is
+   * returned asynchronously. If there is no identifier, no way the client can tell which response
+   * belongs to which request.
+   *
+   * Apart from sending response, `req_guid` is used to log some informations on 'debug' level. You can search the
+   * debug logs with `ReqGUID` keyword.
+   *
+   * @generated from field: string req_guid = 1;
+   */
+  reqGuid: string;
+
+  /**
+   *
+   * `sent_time` defines the time the request is sent.
+   *
+   * `sent_time` is used to calculate various metrics. The main metric uses `sent_time` is duration from the
+   * request is sent until the events are published.
+   *
+   * @generated from field: google.protobuf.Timestamp sent_time = 2;
+   */
+  sentTime?: Timestamp;
+
+  /**
+   *
+   * `events` is where the client put all the events wrapped in `Event`.
+   *
+   * As mentioned above, the request allows the client to push more than one event. Normally you want to batch
+   * the events to optimize the network call.
+   *
+   * @generated from field: repeated raystack.raccoon.v1beta1.Event events = 3;
+   */
+  events: Event[];
+};
+
+/**
+ * Describes the message raystack.raccoon.v1beta1.SendEventRequest.
+ * Use `create(SendEventRequestSchema)` to create a new message.
+ */
+export declare const SendEventRequestSchema: GenMessage<SendEventRequest>;
+
+/**
+ * @generated from message raystack.raccoon.v1beta1.Event
+ */
+export declare type Event = Message<"raystack.raccoon.v1beta1.Event"> & {
+  /**
+   *
+   * `event_bytes` is where you put bytes serialized event.
+   *
+   * @generated from field: bytes event_bytes = 1;
+   */
+  eventBytes: Uint8Array;
+
+  /**
+   *
+   * `type` denotes an event type that the producer of this proto message may set.
+   *
+   * It is currently used by raccoon to distribute events to respective Kafka topics. However the
+   * users of this proto can use this type to set strings which can be processed in their
+   * ingestion systems to distribute or perform other functions.
+   *
+   * @generated from field: string type = 2;
+   */
+  type: string;
+};
+
+/**
+ * Describes the message raystack.raccoon.v1beta1.Event.
+ * Use `create(EventSchema)` to create a new message.
+ */
+export declare const EventSchema: GenMessage<Event>;
+
+/**
+ * @generated from message raystack.raccoon.v1beta1.SendEventResponse
+ */
+export declare type SendEventResponse = Message<"raystack.raccoon.v1beta1.SendEventResponse"> & {
+  /**
+   *
+   * `status` denotes status of the request.
+   *
+   * Only 3 values are valid. `SUCCESS` means the the request is processed
+   * successfully. `ERROR` means the request failed to be processed. `UNKNOWN_STATUS`
+   * means Raccoon unable to determine whether the request is success or not.
+   *
+   * @generated from field: raystack.raccoon.v1beta1.Status status = 1;
+   */
+  status: Status;
+
+  /**
+   *
+   * `code` gives more detail of what happened to the request.
+   *
+   * Details of available `code` can be seen below.
+   *
+   * @generated from field: raystack.raccoon.v1beta1.Code code = 2;
+   */
+  code: Code;
+
+  /**
+   *
+   * `sent_time` is UNIX timestamp populated by Raccoon by the time the response is sent.
+   *
+   * @generated from field: int64 sent_time = 3;
+   */
+  sentTime: bigint;
+
+  /**
+   *
+   * `reason` is additional-human readable information to provide more context to `status` and `code`.
+   *
+   * There is no predefined structure for this. The value is arbitrary.
+   *
+   * @generated from field: string reason = 4;
+   */
+  reason: string;
+
+  /**
+   *
+   * `data` is arbitrary extra metadata.
+   *
+   * Arbitrary key-value makes the field flexible for future changes. `req_guid` is also sent as part
+   * of `data`. The client may fetch req_guid as key to get the `req_guid` value.
+   *
+   * @generated from field: map<string, string> data = 5;
+   */
+  data: { [key: string]: string };
+};
+
+/**
+ * Describes the message raystack.raccoon.v1beta1.SendEventResponse.
+ * Use `create(SendEventResponseSchema)` to create a new message.
+ */
+export declare const SendEventResponseSchema: GenMessage<SendEventResponse>;
+
+/**
+ * @generated from enum raystack.raccoon.v1beta1.Status
+ */
+export enum Status {
+  /**
+   * @generated from enum value: STATUS_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * @generated from enum value: STATUS_SUCCESS = 1;
+   */
+  SUCCESS = 1,
+
+  /**
+   * @generated from enum value: STATUS_ERROR = 2;
+   */
+  ERROR = 2,
+}
+
+/**
+ * Describes the enum raystack.raccoon.v1beta1.Status.
+ */
+export declare const StatusSchema: GenEnum<Status>;
+
+/**
+ * @generated from enum raystack.raccoon.v1beta1.Code
+ */
+export enum Code {
+  /**
+   *
+   * `CODE_UNSPECIFIED` indicates no appropriate/existing code can describe it.
+   *
+   * @generated from enum value: CODE_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   *
+   * `OK` indicates the request is processed successfully.
+   *
+   * @generated from enum value: CODE_OK = 1;
+   */
+  OK = 1,
+
+  /**
+   *
+   * `BAD_REQUEST` indicates there is something wrong with the request.
+   *
+   * @generated from enum value: CODE_BAD_REQUEST = 2;
+   */
+  BAD_REQUEST = 2,
+
+  /**
+   *
+   * `INTERNAL_ERROR` indicates that Raccoon encountered an unexpected condition that prevented it from fulfilling the request.
+   *
+   * @generated from enum value: CODE_INTERNAL_ERROR = 3;
+   */
+  INTERNAL_ERROR = 3,
+
+  /**
+   *
+   * `MAX_CONNECTION_LIMIT_REACHED` indicates that Raccoon is unable to accepts new connection due to max connection is reached.
+   *
+   * To prevent Raccoon from eating up resources, connection limit needs to be set. The limit is configurable on Raccoon by setting `SERVER_WEBSOCKET_MAX_CONN`
+   *
+   * @generated from enum value: CODE_MAX_CONNECTION_LIMIT_REACHED = 4;
+   */
+  MAX_CONNECTION_LIMIT_REACHED = 4,
+
+  /**
+   *
+   * `MAX_USER_LIMIT_REACHED` indicates that existing connection with the same ID.
+   *
+   * Raccoon ensures unique connection using unique identifier passed from the header
+   * the first time Websocket connection is established. The header key that
+   * contains unique identifier is configurable on Raccoon by setting `SERVER_WEBSOCKET_CONN_UNIQ_ID_HEADER`
+   *
+   * @generated from enum value: CODE_MAX_USER_LIMIT_REACHED = 5;
+   */
+  MAX_USER_LIMIT_REACHED = 5,
+}
+
+/**
+ * Describes the enum raystack.raccoon.v1beta1.Code.
+ */
+export declare const CodeSchema: GenEnum<Code>;
+
+/**
+ * @generated from service raystack.raccoon.v1beta1.EventService
+ */
+export declare const EventService: GenService<{
+  /**
+   * @generated from rpc raystack.raccoon.v1beta1.EventService.SendEvent
+   */
+  sendEvent: {
+    methodKind: "unary";
+    input: typeof SendEventRequestSchema;
+    output: typeof SendEventResponseSchema;
+  },
+}>;
+

package/raystack/raccoon/v1beta1/raccoon_pb.js

@@ -0,0 +1,64 @@
+// @generated by protoc-gen-es v2.6.2 with parameter "target=ts+js+dts,import_extension=none"
+// @generated from file raystack/raccoon/v1beta1/raccoon.proto (package raystack.raccoon.v1beta1, syntax proto3)
+/* eslint-disable */
+
+import { enumDesc, fileDesc, messageDesc, serviceDesc, tsEnum } from "@bufbuild/protobuf/codegenv2";
+import { file_google_protobuf_timestamp } from "@bufbuild/protobuf/wkt";
+
+/**
+ * Describes the file raystack/raccoon/v1beta1/raccoon.proto.
+ */
+export const file_raystack_raccoon_v1beta1_raccoon = /*@__PURE__*/
+  fileDesc("CiZyYXlzdGFjay9yYWNjb29uL3YxYmV0YTEvcmFjY29vbi5wcm90bxIYcmF5c3RhY2sucmFjY29vbi52MWJldGExIoQBChBTZW5kRXZlbnRSZXF1ZXN0EhAKCHJlcV9ndWlkGAEgASgJEi0KCXNlbnRfdGltZRgCIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXASLwoGZXZlbnRzGAMgAygLMh8ucmF5c3RhY2sucmFjY29vbi52MWJldGExLkV2ZW50IioKBUV2ZW50EhMKC2V2ZW50X2J5dGVzGAEgASgMEgwKBHR5cGUYAiABKAkiiAIKEVNlbmRFdmVudFJlc3BvbnNlEjAKBnN0YXR1cxgBIAEoDjIgLnJheXN0YWNrLnJhY2Nvb24udjFiZXRhMS5TdGF0dXMSLAoEY29kZRgCIAEoDjIeLnJheXN0YWNrLnJhY2Nvb24udjFiZXRhMS5Db2RlEhEKCXNlbnRfdGltZRgDIAEoAxIOCgZyZWFzb24YBCABKAkSQwoEZGF0YRgFIAMoCzI1LnJheXN0YWNrLnJhY2Nvb24udjFiZXRhMS5TZW5kRXZlbnRSZXNwb25zZS5EYXRhRW50cnkaKwoJRGF0YUVudHJ5EgsKA2tleRgBIAEoCRINCgV2YWx1ZRgCIAEoCToCOAEqRgoGU3RhdHVzEhYKElNUQVRVU19VTlNQRUNJRklFRBAAEhIKDlNUQVRVU19TVUNDRVNTEAESEAoMU1RBVFVTX0VSUk9SEAIqoAEKBENvZGUSFAoQQ09ERV9VTlNQRUNJRklFRBAAEgsKB0NPREVfT0sQARIUChBDT0RFX0JBRF9SRVFVRVNUEAISFwoTQ09ERV9JTlRFUk5BTF9FUlJPUhADEiUKIUNPREVfTUFYX0NPTk5FQ1RJT05fTElNSVRfUkVBQ0hFRBAEEh8KG0NPREVfTUFYX1VTRVJfTElNSVRfUkVBQ0hFRBAFMnQKDEV2ZW50U2VydmljZRJkCglTZW5kRXZlbnQSKi5yYXlzdGFjay5yYWNjb29uLnYxYmV0YTEuU2VuZEV2ZW50UmVxdWVzdBorLnJheXN0YWNrLnJhY2Nvb24udjFiZXRhMS5TZW5kRXZlbnRSZXNwb25zZUJbChppby5yYXlzdGFjay5wcm90b24ucmFjY29vbkIKRXZlbnRQcm90b1ABWi9naXRodWIuY29tL3JheXN0YWNrL3Byb3Rvbi9yYWNjb29uL3YxO3JhY2Nvb252MWIGcHJvdG8z", [file_google_protobuf_timestamp]);
+
+/**
+ * Describes the message raystack.raccoon.v1beta1.SendEventRequest.
+ * Use `create(SendEventRequestSchema)` to create a new message.
+ */
+export const SendEventRequestSchema = /*@__PURE__*/
+  messageDesc(file_raystack_raccoon_v1beta1_raccoon, 0);
+
+/**
+ * Describes the message raystack.raccoon.v1beta1.Event.
+ * Use `create(EventSchema)` to create a new message.
+ */
+export const EventSchema = /*@__PURE__*/
+  messageDesc(file_raystack_raccoon_v1beta1_raccoon, 1);
+
+/**
+ * Describes the message raystack.raccoon.v1beta1.SendEventResponse.
+ * Use `create(SendEventResponseSchema)` to create a new message.
+ */
+export const SendEventResponseSchema = /*@__PURE__*/
+  messageDesc(file_raystack_raccoon_v1beta1_raccoon, 2);
+
+/**
+ * Describes the enum raystack.raccoon.v1beta1.Status.
+ */
+export const StatusSchema = /*@__PURE__*/
+  enumDesc(file_raystack_raccoon_v1beta1_raccoon, 0);
+
+/**
+ * @generated from enum raystack.raccoon.v1beta1.Status
+ */
+export const Status = /*@__PURE__*/
+  tsEnum(StatusSchema);
+
+/**
+ * Describes the enum raystack.raccoon.v1beta1.Code.
+ */
+export const CodeSchema = /*@__PURE__*/
+  enumDesc(file_raystack_raccoon_v1beta1_raccoon, 1);
+
+/**
+ * @generated from enum raystack.raccoon.v1beta1.Code
+ */
+export const Code = /*@__PURE__*/
+  tsEnum(CodeSchema);
+
+/**
+ * @generated from service raystack.raccoon.v1beta1.EventService
+ */
+export const EventService = /*@__PURE__*/
+  serviceDesc(file_raystack_raccoon_v1beta1_raccoon, 0);
+