@raystack/proton 0.1.0-ce225175aa066e6f296bc489293bb83ed0edcef6

package/raystack/raccoon/v1beta1/raccoon.ts

@@ -0,0 +1,442 @@
+// @generated by protobuf-ts 2.11.1
+// @generated from protobuf file "raystack/raccoon/v1beta1/raccoon.proto" (package "raystack.raccoon.v1beta1", syntax proto3)
+// tslint:disable
+import { ServiceType } from "@protobuf-ts/runtime-rpc";
+import type { BinaryWriteOptions } from "@protobuf-ts/runtime";
+import type { IBinaryWriter } from "@protobuf-ts/runtime";
+import { WireType } from "@protobuf-ts/runtime";
+import type { BinaryReadOptions } from "@protobuf-ts/runtime";
+import type { IBinaryReader } from "@protobuf-ts/runtime";
+import { UnknownFieldHandler } from "@protobuf-ts/runtime";
+import type { PartialMessage } from "@protobuf-ts/runtime";
+import { reflectionMergePartial } from "@protobuf-ts/runtime";
+import { MessageType } from "@protobuf-ts/runtime";
+import { Timestamp } from "../../../google/protobuf/timestamp";
+/**
+ *
+ * `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 protobuf message raystack.raccoon.v1beta1.SendEventRequest
+ */
+export interface 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 protobuf 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 protobuf 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 protobuf field: repeated raystack.raccoon.v1beta1.Event events = 3
+     */
+    events: Event[];
+}
+// 
+// `Event` defines wrapper of the event you want to push to Raccoon
+// 
+// The event populated here is in form of bytes. It means you can use any data format or schema
+// you want for your event. You can structure your event on protobuf as you like. The data then
+// needs to be serialized to bytes and populate it in `event_bytes` field. Single `Event` contains one event.
+
+/**
+ * @generated from protobuf message raystack.raccoon.v1beta1.Event
+ */
+export interface Event {
+    /**
+     *
+     * `event_bytes` is where you put bytes serialized event.
+     *
+     * @generated from protobuf 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 protobuf field: string type = 2
+     */
+    type: string;
+}
+// 
+// `EventResponse` defines the response contract from Raccoon
+// 
+// Raccoon sends `EventResponse` for each `EventRequest` received. For WebSocket,
+// `EventResponse` is also used to send the final message in case connection is failed to
+// established.
+
+/**
+ * @generated from protobuf message raystack.raccoon.v1beta1.SendEventResponse
+ */
+export interface 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 protobuf 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 protobuf 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 protobuf 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 protobuf 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 protobuf field: map<string, string> data = 5
+     */
+    data: {
+        [key: string]: string;
+    };
+}
+/**
+ * @generated from protobuf enum raystack.raccoon.v1beta1.Status
+ */
+export enum Status {
+    /**
+     * @generated from protobuf enum value: STATUS_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * @generated from protobuf enum value: STATUS_SUCCESS = 1;
+     */
+    SUCCESS = 1,
+    /**
+     * @generated from protobuf enum value: STATUS_ERROR = 2;
+     */
+    ERROR = 2
+}
+/**
+ * @generated from protobuf enum raystack.raccoon.v1beta1.Code
+ */
+export enum Code {
+    /**
+     *
+     * `CODE_UNSPECIFIED` indicates no appropriate/existing code can describe it.
+     *
+     * @generated from protobuf enum value: CODE_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     *
+     * `OK` indicates the request is processed successfully.
+     *
+     * @generated from protobuf enum value: CODE_OK = 1;
+     */
+    OK = 1,
+    /**
+     *
+     * `BAD_REQUEST` indicates there is something wrong with the request.
+     *
+     * @generated from protobuf 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 protobuf 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 protobuf 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 protobuf enum value: CODE_MAX_USER_LIMIT_REACHED = 5;
+     */
+    MAX_USER_LIMIT_REACHED = 5
+}
+// @generated message type with reflection information, may provide speed optimized methods
+class SendEventRequest$Type extends MessageType<SendEventRequest> {
+    constructor() {
+        super("raystack.raccoon.v1beta1.SendEventRequest", [
+            { 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", repeat: 2 /*RepeatType.UNPACKED*/, T: () => Event }
+        ]);
+    }
+    create(value?: PartialMessage<SendEventRequest>): SendEventRequest {
+        const message = globalThis.Object.create((this.messagePrototype!));
+        message.reqGuid = "";
+        message.events = [];
+        if (value !== undefined)
+            reflectionMergePartial<SendEventRequest>(this, message, value);
+        return message;
+    }
+    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: SendEventRequest): SendEventRequest {
+        let message = target ?? this.create(), end = reader.pos + length;
+        while (reader.pos < end) {
+            let [fieldNo, wireType] = reader.tag();
+            switch (fieldNo) {
+                case /* string req_guid */ 1:
+                    message.reqGuid = reader.string();
+                    break;
+                case /* google.protobuf.Timestamp sent_time */ 2:
+                    message.sentTime = Timestamp.internalBinaryRead(reader, reader.uint32(), options, message.sentTime);
+                    break;
+                case /* repeated raystack.raccoon.v1beta1.Event events */ 3:
+                    message.events.push(Event.internalBinaryRead(reader, reader.uint32(), options));
+                    break;
+                default:
+                    let u = options.readUnknownField;
+                    if (u === "throw")
+                        throw new globalThis.Error(`Unknown field ${fieldNo} (wire type ${wireType}) for ${this.typeName}`);
+                    let d = reader.skip(wireType);
+                    if (u !== false)
+                        (u === true ? UnknownFieldHandler.onRead : u)(this.typeName, message, fieldNo, wireType, d);
+            }
+        }
+        return message;
+    }
+    internalBinaryWrite(message: SendEventRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter {
+        /* string req_guid = 1; */
+        if (message.reqGuid !== "")
+            writer.tag(1, WireType.LengthDelimited).string(message.reqGuid);
+        /* google.protobuf.Timestamp sent_time = 2; */
+        if (message.sentTime)
+            Timestamp.internalBinaryWrite(message.sentTime, writer.tag(2, WireType.LengthDelimited).fork(), options).join();
+        /* repeated raystack.raccoon.v1beta1.Event events = 3; */
+        for (let i = 0; i < message.events.length; i++)
+            Event.internalBinaryWrite(message.events[i], writer.tag(3, WireType.LengthDelimited).fork(), options).join();
+        let u = options.writeUnknownFields;
+        if (u !== false)
+            (u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
+        return writer;
+    }
+}
+/**
+ * @generated MessageType for protobuf message raystack.raccoon.v1beta1.SendEventRequest
+ */
+export const SendEventRequest = new SendEventRequest$Type();
+// @generated message type with reflection information, may provide speed optimized methods
+class Event$Type extends MessageType<Event> {
+    constructor() {
+        super("raystack.raccoon.v1beta1.Event", [
+            { no: 1, name: "event_bytes", kind: "scalar", T: 12 /*ScalarType.BYTES*/ },
+            { no: 2, name: "type", kind: "scalar", T: 9 /*ScalarType.STRING*/ }
+        ]);
+    }
+    create(value?: PartialMessage<Event>): Event {
+        const message = globalThis.Object.create((this.messagePrototype!));
+        message.eventBytes = new Uint8Array(0);
+        message.type = "";
+        if (value !== undefined)
+            reflectionMergePartial<Event>(this, message, value);
+        return message;
+    }
+    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: Event): Event {
+        let message = target ?? this.create(), end = reader.pos + length;
+        while (reader.pos < end) {
+            let [fieldNo, wireType] = reader.tag();
+            switch (fieldNo) {
+                case /* bytes event_bytes */ 1:
+                    message.eventBytes = reader.bytes();
+                    break;
+                case /* string type */ 2:
+                    message.type = reader.string();
+                    break;
+                default:
+                    let u = options.readUnknownField;
+                    if (u === "throw")
+                        throw new globalThis.Error(`Unknown field ${fieldNo} (wire type ${wireType}) for ${this.typeName}`);
+                    let d = reader.skip(wireType);
+                    if (u !== false)
+                        (u === true ? UnknownFieldHandler.onRead : u)(this.typeName, message, fieldNo, wireType, d);
+            }
+        }
+        return message;
+    }
+    internalBinaryWrite(message: Event, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter {
+        /* bytes event_bytes = 1; */
+        if (message.eventBytes.length)
+            writer.tag(1, WireType.LengthDelimited).bytes(message.eventBytes);
+        /* string type = 2; */
+        if (message.type !== "")
+            writer.tag(2, WireType.LengthDelimited).string(message.type);
+        let u = options.writeUnknownFields;
+        if (u !== false)
+            (u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
+        return writer;
+    }
+}
+/**
+ * @generated MessageType for protobuf message raystack.raccoon.v1beta1.Event
+ */
+export const Event = new Event$Type();
+// @generated message type with reflection information, may provide speed optimized methods
+class SendEventResponse$Type extends MessageType<SendEventResponse> {
+    constructor() {
+        super("raystack.raccoon.v1beta1.SendEventResponse", [
+            { no: 1, name: "status", kind: "enum", T: () => ["raystack.raccoon.v1beta1.Status", Status, "STATUS_"] },
+            { no: 2, name: "code", kind: "enum", T: () => ["raystack.raccoon.v1beta1.Code", Code, "CODE_"] },
+            { no: 3, name: "sent_time", kind: "scalar", T: 3 /*ScalarType.INT64*/, L: 0 /*LongType.BIGINT*/ },
+            { 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*/ } }
+        ]);
+    }
+    create(value?: PartialMessage<SendEventResponse>): SendEventResponse {
+        const message = globalThis.Object.create((this.messagePrototype!));
+        message.status = 0;
+        message.code = 0;
+        message.sentTime = 0n;
+        message.reason = "";
+        message.data = {};
+        if (value !== undefined)
+            reflectionMergePartial<SendEventResponse>(this, message, value);
+        return message;
+    }
+    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: SendEventResponse): SendEventResponse {
+        let message = target ?? this.create(), end = reader.pos + length;
+        while (reader.pos < end) {
+            let [fieldNo, wireType] = reader.tag();
+            switch (fieldNo) {
+                case /* raystack.raccoon.v1beta1.Status status */ 1:
+                    message.status = reader.int32();
+                    break;
+                case /* raystack.raccoon.v1beta1.Code code */ 2:
+                    message.code = reader.int32();
+                    break;
+                case /* int64 sent_time */ 3:
+                    message.sentTime = reader.int64().toBigInt();
+                    break;
+                case /* string reason */ 4:
+                    message.reason = reader.string();
+                    break;
+                case /* map<string, string> data */ 5:
+                    this.binaryReadMap5(message.data, reader, options);
+                    break;
+                default:
+                    let u = options.readUnknownField;
+                    if (u === "throw")
+                        throw new globalThis.Error(`Unknown field ${fieldNo} (wire type ${wireType}) for ${this.typeName}`);
+                    let d = reader.skip(wireType);
+                    if (u !== false)
+                        (u === true ? UnknownFieldHandler.onRead : u)(this.typeName, message, fieldNo, wireType, d);
+            }
+        }
+        return message;
+    }
+    private binaryReadMap5(map: SendEventResponse["data"], reader: IBinaryReader, options: BinaryReadOptions): void {
+        let len = reader.uint32(), end = reader.pos + len, key: keyof SendEventResponse["data"] | undefined, val: SendEventResponse["data"][any] | undefined;
+        while (reader.pos < end) {
+            let [fieldNo, wireType] = reader.tag();
+            switch (fieldNo) {
+                case 1:
+                    key = reader.string();
+                    break;
+                case 2:
+                    val = reader.string();
+                    break;
+                default: throw new globalThis.Error("unknown map entry field for raystack.raccoon.v1beta1.SendEventResponse.data");
+            }
+        }
+        map[key ?? ""] = val ?? "";
+    }
+    internalBinaryWrite(message: SendEventResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter {
+        /* raystack.raccoon.v1beta1.Status status = 1; */
+        if (message.status !== 0)
+            writer.tag(1, WireType.Varint).int32(message.status);
+        /* raystack.raccoon.v1beta1.Code code = 2; */
+        if (message.code !== 0)
+            writer.tag(2, WireType.Varint).int32(message.code);
+        /* int64 sent_time = 3; */
+        if (message.sentTime !== 0n)
+            writer.tag(3, WireType.Varint).int64(message.sentTime);
+        /* string reason = 4; */
+        if (message.reason !== "")
+            writer.tag(4, WireType.LengthDelimited).string(message.reason);
+        /* map<string, string> data = 5; */
+        for (let k of globalThis.Object.keys(message.data))
+            writer.tag(5, WireType.LengthDelimited).fork().tag(1, WireType.LengthDelimited).string(k).tag(2, WireType.LengthDelimited).string(message.data[k]).join();
+        let u = options.writeUnknownFields;
+        if (u !== false)
+            (u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
+        return writer;
+    }
+}
+/**
+ * @generated MessageType for protobuf message raystack.raccoon.v1beta1.SendEventResponse
+ */
+export const SendEventResponse = new SendEventResponse$Type();
+/**
+ * @generated ServiceType for protobuf service raystack.raccoon.v1beta1.EventService
+ */
+export const EventService = new ServiceType("raystack.raccoon.v1beta1.EventService", [
+    { name: "SendEvent", options: {}, I: SendEventRequest, O: SendEventResponse }
+]);

package/raystack/raccoon/v1beta1/raccoon_connect.ts

@@ -0,0 +1,26 @@
+// @generated by protoc-gen-connect-es v1.6.1 with parameter "target=ts"
+// @generated from file raystack/raccoon/v1beta1/raccoon.proto (package raystack.raccoon.v1beta1, syntax proto3)
+/* eslint-disable */
+// @ts-nocheck
+
+import { SendEventRequest, SendEventResponse } from "./raccoon_pb.js";
+import { MethodKind } from "@bufbuild/protobuf";
+
+/**
+ * @generated from service raystack.raccoon.v1beta1.EventService
+ */
+export const EventService = {
+  typeName: "raystack.raccoon.v1beta1.EventService",
+  methods: {
+    /**
+     * @generated from rpc raystack.raccoon.v1beta1.EventService.SendEvent
+     */
+    sendEvent: {
+      name: "SendEvent",
+      I: SendEventRequest,
+      O: SendEventResponse,
+      kind: MethodKind.Unary,
+    },
+  }
+} as const;
+