@raystack/proton 0.1.0-ce225175aa066e6f296bc489293bb83ed0edcef6

package/raystack/raccoon/v1beta1/raccoon_pb.ts

@@ -0,0 +1,324 @@
+// @generated by protoc-gen-es v1.10.1 with parameter "target=ts,import_extension=none"
+// @generated from file raystack/raccoon/v1beta1/raccoon.proto (package raystack.raccoon.v1beta1, syntax proto3)
+/* eslint-disable */
+// @ts-nocheck
+
+import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
+import { Message, proto3, protoInt64, Timestamp } from "@bufbuild/protobuf";
+
+/**
+ * @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,
+}
+// Retrieve enum metadata with: proto3.getEnumType(Status)
+proto3.util.setEnumType(Status, "raystack.raccoon.v1beta1.Status", [
+  { no: 0, name: "STATUS_UNSPECIFIED" },
+  { no: 1, name: "STATUS_SUCCESS" },
+  { no: 2, name: "STATUS_ERROR" },
+]);
+
+/**
+ * @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,
+}
+// Retrieve enum metadata with: proto3.getEnumType(Code)
+proto3.util.setEnumType(Code, "raystack.raccoon.v1beta1.Code", [
+  { no: 0, name: "CODE_UNSPECIFIED" },
+  { no: 1, name: "CODE_OK" },
+  { no: 2, name: "CODE_BAD_REQUEST" },
+  { no: 3, name: "CODE_INTERNAL_ERROR" },
+  { no: 4, name: "CODE_MAX_CONNECTION_LIMIT_REACHED" },
+  { no: 5, name: "CODE_MAX_USER_LIMIT_REACHED" },
+]);
+
+/**
+ *
+ * `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 class SendEventRequest extends Message<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 = "";
+
+  /**
+   *
+   * `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[] = [];
+
+  constructor(data?: PartialMessage<SendEventRequest>) {
+    super();
+    proto3.util.initPartial(data, this);
+  }
+
+  static readonly runtime: typeof proto3 = proto3;
+  static readonly typeName = "raystack.raccoon.v1beta1.SendEventRequest";
+  static readonly fields: FieldList = proto3.util.newFieldList(() => [
+    { no: 1, name: "req_guid", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: "sent_time", kind: "message", T: Timestamp },
+    { no: 3, name: "events", kind: "message", T: Event, repeated: true },
+  ]);
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): SendEventRequest {
+    return new SendEventRequest().fromBinary(bytes, options);
+  }
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): SendEventRequest {
+    return new SendEventRequest().fromJson(jsonValue, options);
+  }
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): SendEventRequest {
+    return new SendEventRequest().fromJsonString(jsonString, options);
+  }
+
+  static equals(a: SendEventRequest | PlainMessage<SendEventRequest> | undefined, b: SendEventRequest | PlainMessage<SendEventRequest> | undefined): boolean {
+    return proto3.util.equals(SendEventRequest, a, b);
+  }
+}
+
+/**
+ * @generated from message raystack.raccoon.v1beta1.Event
+ */
+export class Event extends Message<Event> {
+  /**
+   *
+   * `event_bytes` is where you put bytes serialized event.
+   *
+   * @generated from field: bytes event_bytes = 1;
+   */
+  eventBytes = new Uint8Array(0);
+
+  /**
+   *
+   * `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 = "";
+
+  constructor(data?: PartialMessage<Event>) {
+    super();
+    proto3.util.initPartial(data, this);
+  }
+
+  static readonly runtime: typeof proto3 = proto3;
+  static readonly typeName = "raystack.raccoon.v1beta1.Event";
+  static readonly fields: FieldList = proto3.util.newFieldList(() => [
+    { no: 1, name: "event_bytes", kind: "scalar", T: 12 /* ScalarType.BYTES */ },
+    { no: 2, name: "type", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+  ]);
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Event {
+    return new Event().fromBinary(bytes, options);
+  }
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Event {
+    return new Event().fromJson(jsonValue, options);
+  }
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Event {
+    return new Event().fromJsonString(jsonString, options);
+  }
+
+  static equals(a: Event | PlainMessage<Event> | undefined, b: Event | PlainMessage<Event> | undefined): boolean {
+    return proto3.util.equals(Event, a, b);
+  }
+}
+
+/**
+ * @generated from message raystack.raccoon.v1beta1.SendEventResponse
+ */
+export class SendEventResponse extends Message<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.UNSPECIFIED;
+
+  /**
+   *
+   * `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.UNSPECIFIED;
+
+  /**
+   *
+   * `sent_time` is UNIX timestamp populated by Raccoon by the time the response is sent.
+   *
+   * @generated from field: int64 sent_time = 3;
+   */
+  sentTime = protoInt64.zero;
+
+  /**
+   *
+   * `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 = "";
+
+  /**
+   *
+   * `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 } = {};
+
+  constructor(data?: PartialMessage<SendEventResponse>) {
+    super();
+    proto3.util.initPartial(data, this);
+  }
+
+  static readonly runtime: typeof proto3 = proto3;
+  static readonly typeName = "raystack.raccoon.v1beta1.SendEventResponse";
+  static readonly fields: FieldList = proto3.util.newFieldList(() => [
+    { no: 1, name: "status", kind: "enum", T: proto3.getEnumType(Status) },
+    { no: 2, name: "code", kind: "enum", T: proto3.getEnumType(Code) },
+    { no: 3, name: "sent_time", kind: "scalar", T: 3 /* ScalarType.INT64 */ },
+    { no: 4, name: "reason", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 5, name: "data", kind: "map", K: 9 /* ScalarType.STRING */, V: {kind: "scalar", T: 9 /* ScalarType.STRING */} },
+  ]);
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): SendEventResponse {
+    return new SendEventResponse().fromBinary(bytes, options);
+  }
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): SendEventResponse {
+    return new SendEventResponse().fromJson(jsonValue, options);
+  }
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): SendEventResponse {
+    return new SendEventResponse().fromJsonString(jsonString, options);
+  }
+
+  static equals(a: SendEventResponse | PlainMessage<SendEventResponse> | undefined, b: SendEventResponse | PlainMessage<SendEventResponse> | undefined): boolean {
+    return proto3.util.equals(SendEventResponse, a, b);
+  }
+}
+

package/raystack/siren/index.ts

@@ -0,0 +1,3 @@
+export { SirenService } from "./v1beta1/siren_connect";
+export * as SirenServiceQueries from "./v1beta1/siren-SirenService_connectquery";
+export * from "./v1beta1/siren";