@raystack/proton 0.1.0-ce225175aa066e6f296bc489293bb83ed0edcef6

package/raystack/assets/v1beta2/experiment.ts

@@ -0,0 +1,274 @@
+// @generated by protobuf-ts 2.11.1
+// @generated from protobuf file "raystack/assets/v1beta2/experiment.proto" (package "raystack.assets.v1beta2", syntax proto3)
+// tslint:disable
+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";
+import { Struct } from "../../../google/protobuf/struct";
+/**
+ * An experiment is the set of configurations and filters that allow for
+ * systematically varying some independent variables to impact some other
+ * dependent variables.
+ *
+ * @generated from protobuf message raystack.assets.v1beta2.Experiment
+ */
+export interface Experiment {
+    /**
+     * Optional: Type of the entity being experimented over. ex: customer, session,
+     * device, driver etc.
+     *
+     * @generated from protobuf field: string entity = 1
+     */
+    entity: string;
+    /**
+     * Optional: Percentage of the traffic that the experiment is enabled for.
+     *
+     * @generated from protobuf field: float traffic_percent = 2
+     */
+    trafficPercent: number;
+    /**
+     * The variants of the experiment possibly including the control group.
+     *
+     * @generated from protobuf field: repeated raystack.assets.v1beta2.Experiment.Variant variants = 3
+     */
+    variants: Experiment_Variant[];
+    /**
+     * Optional: List of attributes the experiment has. This could include the
+     * following:
+     * - client_id[string]: The ID if the client running the experiment.
+     * - client_name[string]: The name of the client running the experiment.
+     * - primary_metric[string]: Used to determine a statistically significant
+     *   winning or losing variant.
+     * - guardrail_metric[string]: Business metric designed to indirectly measure
+     *   business value and track any potentially misleading or erroneous results
+     *   and analysis.
+     * - variant_sample_size[double]: Sample size per variant.
+     * - filter_rules[repeated string]: Textual representation of rules required
+     *   to be satisfied for experiment to be shown to the user.
+     * - start_time[RFC 3339 string]: The timestamp at which the
+     *   experiment would start.
+     * - end_time[RFC 3339 string]: The timestamp at which the
+     *   experiment would end.
+     *
+     * @generated from protobuf field: google.protobuf.Struct attributes = 5
+     */
+    attributes?: Struct;
+    /**
+     * The timestamp of the experiment's creation.
+     *
+     * @generated from protobuf field: google.protobuf.Timestamp create_time = 101
+     */
+    createTime?: Timestamp;
+    /**
+     * The timestamp when the experiment was last modified.
+     *
+     * @generated from protobuf field: google.protobuf.Timestamp update_time = 102
+     */
+    updateTime?: Timestamp;
+}
+/**
+ * Instance of configurations to be compared in the experiment.
+ *
+ * @generated from protobuf message raystack.assets.v1beta2.Experiment.Variant
+ */
+export interface Experiment_Variant {
+    /**
+     * Name of the experiment variant.
+     *
+     * @generated from protobuf field: string name = 1
+     */
+    name: string;
+    /**
+     * Traffic percent enabled for the variant.
+     *
+     * @generated from protobuf field: float traffic_percent = 2
+     */
+    trafficPercent: number;
+    /**
+     * Indicated whether the variant is the control for the experiment.
+     *
+     * @generated from protobuf field: bool is_control = 3
+     */
+    isControl: boolean;
+    /**
+     * List of properties the entity has.
+     *
+     * @generated from protobuf field: google.protobuf.Struct attributes = 4
+     */
+    attributes?: Struct;
+    /**
+     * Whether the variant has been promoted to all users.
+     *
+     * @generated from protobuf field: bool is_promoted = 5
+     */
+    isPromoted: boolean;
+}
+// @generated message type with reflection information, may provide speed optimized methods
+class Experiment$Type extends MessageType<Experiment> {
+    constructor() {
+        super("raystack.assets.v1beta2.Experiment", [
+            { no: 1, name: "entity", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
+            { no: 2, name: "traffic_percent", kind: "scalar", T: 2 /*ScalarType.FLOAT*/ },
+            { no: 3, name: "variants", kind: "message", repeat: 2 /*RepeatType.UNPACKED*/, T: () => Experiment_Variant },
+            { no: 5, name: "attributes", kind: "message", T: () => Struct },
+            { no: 101, name: "create_time", kind: "message", T: () => Timestamp },
+            { no: 102, name: "update_time", kind: "message", T: () => Timestamp }
+        ]);
+    }
+    create(value?: PartialMessage<Experiment>): Experiment {
+        const message = globalThis.Object.create((this.messagePrototype!));
+        message.entity = "";
+        message.trafficPercent = 0;
+        message.variants = [];
+        if (value !== undefined)
+            reflectionMergePartial<Experiment>(this, message, value);
+        return message;
+    }
+    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: Experiment): Experiment {
+        let message = target ?? this.create(), end = reader.pos + length;
+        while (reader.pos < end) {
+            let [fieldNo, wireType] = reader.tag();
+            switch (fieldNo) {
+                case /* string entity */ 1:
+                    message.entity = reader.string();
+                    break;
+                case /* float traffic_percent */ 2:
+                    message.trafficPercent = reader.float();
+                    break;
+                case /* repeated raystack.assets.v1beta2.Experiment.Variant variants */ 3:
+                    message.variants.push(Experiment_Variant.internalBinaryRead(reader, reader.uint32(), options));
+                    break;
+                case /* google.protobuf.Struct attributes */ 5:
+                    message.attributes = Struct.internalBinaryRead(reader, reader.uint32(), options, message.attributes);
+                    break;
+                case /* google.protobuf.Timestamp create_time */ 101:
+                    message.createTime = Timestamp.internalBinaryRead(reader, reader.uint32(), options, message.createTime);
+                    break;
+                case /* google.protobuf.Timestamp update_time */ 102:
+                    message.updateTime = Timestamp.internalBinaryRead(reader, reader.uint32(), options, message.updateTime);
+                    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: Experiment, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter {
+        /* string entity = 1; */
+        if (message.entity !== "")
+            writer.tag(1, WireType.LengthDelimited).string(message.entity);
+        /* float traffic_percent = 2; */
+        if (message.trafficPercent !== 0)
+            writer.tag(2, WireType.Bit32).float(message.trafficPercent);
+        /* repeated raystack.assets.v1beta2.Experiment.Variant variants = 3; */
+        for (let i = 0; i < message.variants.length; i++)
+            Experiment_Variant.internalBinaryWrite(message.variants[i], writer.tag(3, WireType.LengthDelimited).fork(), options).join();
+        /* google.protobuf.Struct attributes = 5; */
+        if (message.attributes)
+            Struct.internalBinaryWrite(message.attributes, writer.tag(5, WireType.LengthDelimited).fork(), options).join();
+        /* google.protobuf.Timestamp create_time = 101; */
+        if (message.createTime)
+            Timestamp.internalBinaryWrite(message.createTime, writer.tag(101, WireType.LengthDelimited).fork(), options).join();
+        /* google.protobuf.Timestamp update_time = 102; */
+        if (message.updateTime)
+            Timestamp.internalBinaryWrite(message.updateTime, writer.tag(102, 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.assets.v1beta2.Experiment
+ */
+export const Experiment = new Experiment$Type();
+// @generated message type with reflection information, may provide speed optimized methods
+class Experiment_Variant$Type extends MessageType<Experiment_Variant> {
+    constructor() {
+        super("raystack.assets.v1beta2.Experiment.Variant", [
+            { no: 1, name: "name", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
+            { no: 2, name: "traffic_percent", kind: "scalar", T: 2 /*ScalarType.FLOAT*/ },
+            { no: 3, name: "is_control", kind: "scalar", T: 8 /*ScalarType.BOOL*/ },
+            { no: 4, name: "attributes", kind: "message", T: () => Struct },
+            { no: 5, name: "is_promoted", kind: "scalar", T: 8 /*ScalarType.BOOL*/ }
+        ]);
+    }
+    create(value?: PartialMessage<Experiment_Variant>): Experiment_Variant {
+        const message = globalThis.Object.create((this.messagePrototype!));
+        message.name = "";
+        message.trafficPercent = 0;
+        message.isControl = false;
+        message.isPromoted = false;
+        if (value !== undefined)
+            reflectionMergePartial<Experiment_Variant>(this, message, value);
+        return message;
+    }
+    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: Experiment_Variant): Experiment_Variant {
+        let message = target ?? this.create(), end = reader.pos + length;
+        while (reader.pos < end) {
+            let [fieldNo, wireType] = reader.tag();
+            switch (fieldNo) {
+                case /* string name */ 1:
+                    message.name = reader.string();
+                    break;
+                case /* float traffic_percent */ 2:
+                    message.trafficPercent = reader.float();
+                    break;
+                case /* bool is_control */ 3:
+                    message.isControl = reader.bool();
+                    break;
+                case /* google.protobuf.Struct attributes */ 4:
+                    message.attributes = Struct.internalBinaryRead(reader, reader.uint32(), options, message.attributes);
+                    break;
+                case /* bool is_promoted */ 5:
+                    message.isPromoted = reader.bool();
+                    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: Experiment_Variant, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter {
+        /* string name = 1; */
+        if (message.name !== "")
+            writer.tag(1, WireType.LengthDelimited).string(message.name);
+        /* float traffic_percent = 2; */
+        if (message.trafficPercent !== 0)
+            writer.tag(2, WireType.Bit32).float(message.trafficPercent);
+        /* bool is_control = 3; */
+        if (message.isControl !== false)
+            writer.tag(3, WireType.Varint).bool(message.isControl);
+        /* google.protobuf.Struct attributes = 4; */
+        if (message.attributes)
+            Struct.internalBinaryWrite(message.attributes, writer.tag(4, WireType.LengthDelimited).fork(), options).join();
+        /* bool is_promoted = 5; */
+        if (message.isPromoted !== false)
+            writer.tag(5, WireType.Varint).bool(message.isPromoted);
+        let u = options.writeUnknownFields;
+        if (u !== false)
+            (u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
+        return writer;
+    }
+}
+/**
+ * @generated MessageType for protobuf message raystack.assets.v1beta2.Experiment.Variant
+ */
+export const Experiment_Variant = new Experiment_Variant$Type();

package/raystack/assets/v1beta2/experiment_pb.ts

@@ -0,0 +1,180 @@
+// @generated by protoc-gen-es v1.10.1 with parameter "target=ts,import_extension=none"
+// @generated from file raystack/assets/v1beta2/experiment.proto (package raystack.assets.v1beta2, syntax proto3)
+/* eslint-disable */
+// @ts-nocheck
+
+import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
+import { Message, proto3, Struct, Timestamp } from "@bufbuild/protobuf";
+
+/**
+ * An experiment is the set of configurations and filters that allow for
+ * systematically varying some independent variables to impact some other
+ * dependent variables.
+ *
+ * @generated from message raystack.assets.v1beta2.Experiment
+ */
+export class Experiment extends Message<Experiment> {
+  /**
+   * Optional: Type of the entity being experimented over. ex: customer, session,
+   * device, driver etc.
+   *
+   * @generated from field: string entity = 1;
+   */
+  entity = "";
+
+  /**
+   * Optional: Percentage of the traffic that the experiment is enabled for.
+   *
+   * @generated from field: float traffic_percent = 2;
+   */
+  trafficPercent = 0;
+
+  /**
+   * The variants of the experiment possibly including the control group.
+   *
+   * @generated from field: repeated raystack.assets.v1beta2.Experiment.Variant variants = 3;
+   */
+  variants: Experiment_Variant[] = [];
+
+  /**
+   * Optional: List of attributes the experiment has. This could include the
+   * following:
+   * - client_id[string]: The ID if the client running the experiment.
+   * - client_name[string]: The name of the client running the experiment.
+   * - primary_metric[string]: Used to determine a statistically significant
+   *   winning or losing variant.
+   * - guardrail_metric[string]: Business metric designed to indirectly measure
+   *   business value and track any potentially misleading or erroneous results
+   *   and analysis.
+   * - variant_sample_size[double]: Sample size per variant.
+   * - filter_rules[repeated string]: Textual representation of rules required
+   *   to be satisfied for experiment to be shown to the user.
+   * - start_time[RFC 3339 string]: The timestamp at which the
+   *   experiment would start.
+   * - end_time[RFC 3339 string]: The timestamp at which the
+   *   experiment would end.
+   *
+   * @generated from field: google.protobuf.Struct attributes = 5;
+   */
+  attributes?: Struct;
+
+  /**
+   * The timestamp of the experiment's creation.
+   *
+   * @generated from field: google.protobuf.Timestamp create_time = 101;
+   */
+  createTime?: Timestamp;
+
+  /**
+   * The timestamp when the experiment was last modified.
+   *
+   * @generated from field: google.protobuf.Timestamp update_time = 102;
+   */
+  updateTime?: Timestamp;
+
+  constructor(data?: PartialMessage<Experiment>) {
+    super();
+    proto3.util.initPartial(data, this);
+  }
+
+  static readonly runtime: typeof proto3 = proto3;
+  static readonly typeName = "raystack.assets.v1beta2.Experiment";
+  static readonly fields: FieldList = proto3.util.newFieldList(() => [
+    { no: 1, name: "entity", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: "traffic_percent", kind: "scalar", T: 2 /* ScalarType.FLOAT */ },
+    { no: 3, name: "variants", kind: "message", T: Experiment_Variant, repeated: true },
+    { no: 5, name: "attributes", kind: "message", T: Struct },
+    { no: 101, name: "create_time", kind: "message", T: Timestamp },
+    { no: 102, name: "update_time", kind: "message", T: Timestamp },
+  ]);
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Experiment {
+    return new Experiment().fromBinary(bytes, options);
+  }
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Experiment {
+    return new Experiment().fromJson(jsonValue, options);
+  }
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Experiment {
+    return new Experiment().fromJsonString(jsonString, options);
+  }
+
+  static equals(a: Experiment | PlainMessage<Experiment> | undefined, b: Experiment | PlainMessage<Experiment> | undefined): boolean {
+    return proto3.util.equals(Experiment, a, b);
+  }
+}
+
+/**
+ * Instance of configurations to be compared in the experiment.
+ *
+ * @generated from message raystack.assets.v1beta2.Experiment.Variant
+ */
+export class Experiment_Variant extends Message<Experiment_Variant> {
+  /**
+   * Name of the experiment variant.
+   *
+   * @generated from field: string name = 1;
+   */
+  name = "";
+
+  /**
+   * Traffic percent enabled for the variant.
+   *
+   * @generated from field: float traffic_percent = 2;
+   */
+  trafficPercent = 0;
+
+  /**
+   * Indicated whether the variant is the control for the experiment.
+   *
+   * @generated from field: bool is_control = 3;
+   */
+  isControl = false;
+
+  /**
+   * List of properties the entity has.
+   *
+   * @generated from field: google.protobuf.Struct attributes = 4;
+   */
+  attributes?: Struct;
+
+  /**
+   * Whether the variant has been promoted to all users.
+   *
+   * @generated from field: bool is_promoted = 5;
+   */
+  isPromoted = false;
+
+  constructor(data?: PartialMessage<Experiment_Variant>) {
+    super();
+    proto3.util.initPartial(data, this);
+  }
+
+  static readonly runtime: typeof proto3 = proto3;
+  static readonly typeName = "raystack.assets.v1beta2.Experiment.Variant";
+  static readonly fields: FieldList = proto3.util.newFieldList(() => [
+    { no: 1, name: "name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: "traffic_percent", kind: "scalar", T: 2 /* ScalarType.FLOAT */ },
+    { no: 3, name: "is_control", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
+    { no: 4, name: "attributes", kind: "message", T: Struct },
+    { no: 5, name: "is_promoted", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
+  ]);
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Experiment_Variant {
+    return new Experiment_Variant().fromBinary(bytes, options);
+  }
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Experiment_Variant {
+    return new Experiment_Variant().fromJson(jsonValue, options);
+  }
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Experiment_Variant {
+    return new Experiment_Variant().fromJsonString(jsonString, options);
+  }
+
+  static equals(a: Experiment_Variant | PlainMessage<Experiment_Variant> | undefined, b: Experiment_Variant | PlainMessage<Experiment_Variant> | undefined): boolean {
+    return proto3.util.equals(Experiment_Variant, a, b);
+  }
+}
+