@astromonacinema/contracts 1.0.0

package/gen/auth.ts

@@ -0,0 +1,107 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.10.1
+//   protoc               v3.21.12
+// source: auth.proto
+
+/* eslint-disable */
+import { GrpcMethod, GrpcStreamMethod } from "@nestjs/microservices";
+import { wrappers } from "protobufjs";
+import { Observable } from "rxjs";
+import { Any } from "./google/protobuf/any";
+import { Struct } from "./google/protobuf/struct";
+import { Timestamp } from "./google/protobuf/timestamp";
+
+export const protobufPackage = "auth.v1";
+
+/** Перечисление статусов */
+export enum Status {
+  /** STATUS_UNKNOWN - STATUS_UNKNOWN - значение по умолчанию (0): всегда первое значение в enum должно быть 0 */
+  STATUS_UNKNOWN = 0,
+  /** STATUS_ACTIVE - STATUS_ACTIVE - целочисленная константа (1): активный статус */
+  STATUS_ACTIVE = 1,
+  /** STATUS_BANNED - STATUS_BANNED - целочисленная константа (2): заблокированный статус */
+  STATUS_BANNED = 2,
+  UNRECOGNIZED = -1,
+}
+
+export interface SendOtpRequest {
+  identifier: string;
+  type: string;
+}
+
+export interface SendOtpResponse {
+  ok: boolean;
+}
+
+export interface UserSession {
+  id: string;
+  /** временное значение */
+  createdAt:
+    | Timestamp
+    | undefined;
+  /** структура данных JSON формата */
+  data:
+    | { [key: string]: any }
+    | undefined;
+  /** структура данных любого формата */
+  anyData: Any | undefined;
+}
+
+/** Сообщение профиля пользователя */
+export interface UserProfile {
+  /** id - строка (string): текстовый идентификатор переменной длины, UTF-8 */
+  id: string;
+  /** age - 32-битное целое число со знаком (int32): диапазон от -2,147,483,648 до 2,147,483,647 */
+  age: number;
+  /** rating - число двойной точности (double): 64-битное число с плавающей точкой, IEEE 754 */
+  rating: number;
+  /** verified - булево значение (bool): true или false, занимает 1 байт */
+  verified: boolean;
+  /** roles - повторяющееся поле строк (repeated string): массив строковых значений, может быть пустым или содержать множество элементов */
+  roles: string[];
+  /** meta - словарь строка-строка (map<string, string>): ключ и значение - строки, неупорядоченная коллекция пар ключ-значение */
+  meta: { [key: string]: string };
+  /** status - перечисление (Status): одно из предопределенных значений enum Status, хранится как int32 */
+  status: Status;
+  /** phone - строка (string): номер телефона, будет установлен только если email не задан */
+  phone?:
+    | string
+    | undefined;
+  /** email - строка (string): электронная почта, будет установлен только если phone не задан */
+  email?: string | undefined;
+}
+
+export interface UserProfile_MetaEntry {
+  key: string;
+  value: string;
+}
+
+export const AUTH_V1_PACKAGE_NAME = "auth.v1";
+
+wrappers[".google.protobuf.Struct"] = { fromObject: Struct.wrap, toObject: Struct.unwrap } as any;
+
+export interface AuthServiceClient {
+  sendOtp(request: SendOtpRequest): Observable<SendOtpResponse>;
+}
+
+export interface AuthServiceController {
+  sendOtp(request: SendOtpRequest): Promise<SendOtpResponse> | Observable<SendOtpResponse> | SendOtpResponse;
+}
+
+export function AuthServiceControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = ["sendOtp"];
+    for (const method of grpcMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
+      GrpcMethod("AuthService", method)(constructor.prototype[method], method, descriptor);
+    }
+    const grpcStreamMethods: string[] = [];
+    for (const method of grpcStreamMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
+      GrpcStreamMethod("AuthService", method)(constructor.prototype[method], method, descriptor);
+    }
+  };
+}
+
+export const AUTH_SERVICE_NAME = "AuthService";

package/gen/google/protobuf/any.ts

@@ -0,0 +1,129 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.10.1
+//   protoc               v3.21.12
+// source: google/protobuf/any.proto
+
+/* eslint-disable */
+
+export const protobufPackage = "google.protobuf";
+
+/**
+ * `Any` contains an arbitrary serialized protocol buffer message along with a
+ * URL that describes the type of the serialized message.
+ *
+ * Protobuf library provides support to pack/unpack Any values in the form
+ * of utility functions or additional generated methods of the Any type.
+ *
+ * Example 1: Pack and unpack a message in C++.
+ *
+ *     Foo foo = ...;
+ *     Any any;
+ *     any.PackFrom(foo);
+ *     ...
+ *     if (any.UnpackTo(&foo)) {
+ *       ...
+ *     }
+ *
+ * Example 2: Pack and unpack a message in Java.
+ *
+ *     Foo foo = ...;
+ *     Any any = Any.pack(foo);
+ *     ...
+ *     if (any.is(Foo.class)) {
+ *       foo = any.unpack(Foo.class);
+ *     }
+ *
+ * Example 3: Pack and unpack a message in Python.
+ *
+ *     foo = Foo(...)
+ *     any = Any()
+ *     any.Pack(foo)
+ *     ...
+ *     if any.Is(Foo.DESCRIPTOR):
+ *       any.Unpack(foo)
+ *       ...
+ *
+ * Example 4: Pack and unpack a message in Go
+ *
+ *      foo := &pb.Foo{...}
+ *      any, err := anypb.New(foo)
+ *      if err != nil {
+ *        ...
+ *      }
+ *      ...
+ *      foo := &pb.Foo{}
+ *      if err := any.UnmarshalTo(foo); err != nil {
+ *        ...
+ *      }
+ *
+ * The pack methods provided by protobuf library will by default use
+ * 'type.googleapis.com/full.type.name' as the type URL and the unpack
+ * methods only use the fully qualified type name after the last '/'
+ * in the type URL, for example "foo.bar.com/x/y.z" will yield type
+ * name "y.z".
+ *
+ * JSON
+ *
+ * The JSON representation of an `Any` value uses the regular
+ * representation of the deserialized, embedded message, with an
+ * additional field `@type` which contains the type URL. Example:
+ *
+ *     package google.profile;
+ *     message Person {
+ *       string first_name = 1;
+ *       string last_name = 2;
+ *     }
+ *
+ *     {
+ *       "@type": "type.googleapis.com/google.profile.Person",
+ *       "firstName": <string>,
+ *       "lastName": <string>
+ *     }
+ *
+ * If the embedded message type is well-known and has a custom JSON
+ * representation, that representation will be embedded adding a field
+ * `value` which holds the custom JSON in addition to the `@type`
+ * field. Example (for message [google.protobuf.Duration][]):
+ *
+ *     {
+ *       "@type": "type.googleapis.com/google.protobuf.Duration",
+ *       "value": "1.212s"
+ *     }
+ */
+export interface Any {
+  /**
+   * A URL/resource name that uniquely identifies the type of the serialized
+   * protocol buffer message. This string must contain at least
+   * one "/" character. The last segment of the URL's path must represent
+   * the fully qualified name of the type (as in
+   * `path/google.protobuf.Duration`). The name should be in a canonical form
+   * (e.g., leading "." is not accepted).
+   *
+   * In practice, teams usually precompile into the binary all types that they
+   * expect it to use in the context of Any. However, for URLs which use the
+   * scheme `http`, `https`, or no scheme, one can optionally set up a type
+   * server that maps type URLs to message definitions as follows:
+   *
+   * * If no scheme is provided, `https` is assumed.
+   * * An HTTP GET on the URL must yield a [google.protobuf.Type][]
+   *   value in binary format, or produce an error.
+   * * Applications are allowed to cache lookup results based on the
+   *   URL, or have them precompiled into a binary to avoid any
+   *   lookup. Therefore, binary compatibility needs to be preserved
+   *   on changes to types. (Use versioned type names to manage
+   *   breaking changes.)
+   *
+   * Note: this functionality is not currently available in the official
+   * protobuf release, and it is not used for type URLs beginning with
+   * type.googleapis.com.
+   *
+   * Schemes other than `http`, `https` (or the empty scheme) might be
+   * used with implementation specific semantics.
+   */
+  typeUrl: string;
+  /** Must be a valid serialized protocol buffer of the above specified type. */
+  value: Uint8Array;
+}
+
+export const GOOGLE_PROTOBUF_PACKAGE_NAME = "google.protobuf";

package/gen/google/protobuf/struct.ts

@@ -0,0 +1,197 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.10.1
+//   protoc               v3.21.12
+// source: google/protobuf/struct.proto
+
+/* eslint-disable */
+import { wrappers } from "protobufjs";
+
+export const protobufPackage = "google.protobuf";
+
+/**
+ * `NullValue` is a singleton enumeration to represent the null value for the
+ * `Value` type union.
+ *
+ *  The JSON representation for `NullValue` is JSON `null`.
+ */
+export enum NullValue {
+  /** NULL_VALUE - Null value. */
+  NULL_VALUE = 0,
+  UNRECOGNIZED = -1,
+}
+
+/**
+ * `Struct` represents a structured data value, consisting of fields
+ * which map to dynamically typed values. In some languages, `Struct`
+ * might be supported by a native representation. For example, in
+ * scripting languages like JS a struct is represented as an
+ * object. The details of that representation are described together
+ * with the proto support for the language.
+ *
+ * The JSON representation for `Struct` is JSON object.
+ */
+export interface Struct {
+  /** Unordered map of dynamically typed values. */
+  fields: { [key: string]: any | undefined };
+}
+
+export interface Struct_FieldsEntry {
+  key: string;
+  value: any | undefined;
+}
+
+/**
+ * `Value` represents a dynamically typed value which can be either
+ * null, a number, a string, a boolean, a recursive struct value, or a
+ * list of values. A producer of value is expected to set one of these
+ * variants. Absence of any variant indicates an error.
+ *
+ * The JSON representation for `Value` is JSON value.
+ */
+export interface Value {
+  /** Represents a null value. */
+  nullValue?:
+    | NullValue
+    | undefined;
+  /** Represents a double value. */
+  numberValue?:
+    | number
+    | undefined;
+  /** Represents a string value. */
+  stringValue?:
+    | string
+    | undefined;
+  /** Represents a boolean value. */
+  boolValue?:
+    | boolean
+    | undefined;
+  /** Represents a structured value. */
+  structValue?:
+    | { [key: string]: any }
+    | undefined;
+  /** Represents a repeated `Value`. */
+  listValue?: Array<any> | undefined;
+}
+
+/**
+ * `ListValue` is a wrapper around a repeated field of values.
+ *
+ * The JSON representation for `ListValue` is JSON array.
+ */
+export interface ListValue {
+  /** Repeated field of dynamically typed values. */
+  values: any[];
+}
+
+export const GOOGLE_PROTOBUF_PACKAGE_NAME = "google.protobuf";
+
+function createBaseStruct(): Struct {
+  return { fields: {} };
+}
+
+export const Struct: MessageFns<Struct> & StructWrapperFns = {
+  wrap(object: { [key: string]: any } | undefined): Struct {
+    const struct = createBaseStruct();
+
+    if (object !== undefined) {
+      for (const key of globalThis.Object.keys(object)) {
+        struct.fields[key] = Value.wrap(object[key]);
+      }
+    }
+    return struct;
+  },
+
+  unwrap(message: Struct): { [key: string]: any } {
+    const object: { [key: string]: any } = {};
+    if (message.fields) {
+      for (const key of globalThis.Object.keys(message.fields)) {
+        object[key] = Value.unwrap(message.fields[key]);
+      }
+    }
+    return object;
+  },
+};
+
+function createBaseValue(): Value {
+  return {};
+}
+
+export const Value: MessageFns<Value> & AnyValueWrapperFns = {
+  wrap(value: any): Value {
+    const result = {} as any;
+    if (value === null) {
+      result.nullValue = NullValue.NULL_VALUE;
+    } else if (typeof value === "boolean") {
+      result.boolValue = value;
+    } else if (typeof value === "number") {
+      result.numberValue = value;
+    } else if (typeof value === "string") {
+      result.stringValue = value;
+    } else if (globalThis.Array.isArray(value)) {
+      result.listValue = ListValue.wrap(value);
+    } else if (typeof value === "object") {
+      result.structValue = Struct.wrap(value);
+    } else if (typeof value !== "undefined") {
+      throw new globalThis.Error("Unsupported any value type: " + typeof value);
+    }
+    return result;
+  },
+
+  unwrap(message: any): string | number | boolean | Object | null | Array<any> | undefined {
+    if (message?.hasOwnProperty("stringValue") && message.stringValue !== undefined) {
+      return message.stringValue;
+    } else if (message?.hasOwnProperty("numberValue") && message?.numberValue !== undefined) {
+      return message.numberValue;
+    } else if (message?.hasOwnProperty("boolValue") && message?.boolValue !== undefined) {
+      return message.boolValue;
+    } else if (message?.hasOwnProperty("structValue") && message?.structValue !== undefined) {
+      return Struct.unwrap(message.structValue as any);
+    } else if (message?.hasOwnProperty("listValue") && message?.listValue !== undefined) {
+      return ListValue.unwrap(message.listValue);
+    } else if (message?.hasOwnProperty("nullValue") && message?.nullValue !== undefined) {
+      return null;
+    }
+    return undefined;
+  },
+};
+
+function createBaseListValue(): ListValue {
+  return { values: [] };
+}
+
+export const ListValue: MessageFns<ListValue> & ListValueWrapperFns = {
+  wrap(array: Array<any> | undefined): ListValue {
+    const result = createBaseListValue();
+    result.values = (array ?? []).map(Value.wrap);
+    return result;
+  },
+
+  unwrap(message: ListValue): Array<any> {
+    if (message?.hasOwnProperty("values") && globalThis.Array.isArray(message.values)) {
+      return message.values.map(Value.unwrap);
+    } else {
+      return message as any;
+    }
+  },
+};
+
+wrappers[".google.protobuf.Struct"] = { fromObject: Struct.wrap, toObject: Struct.unwrap } as any;
+
+export interface MessageFns<T> {
+}
+
+export interface StructWrapperFns {
+  wrap(object: { [key: string]: any } | undefined): Struct;
+  unwrap(message: Struct): { [key: string]: any };
+}
+
+export interface AnyValueWrapperFns {
+  wrap(value: any): Value;
+  unwrap(message: any): string | number | boolean | Object | null | Array<any> | undefined;
+}
+
+export interface ListValueWrapperFns {
+  wrap(array: Array<any> | undefined): ListValue;
+  unwrap(message: ListValue): Array<any>;
+}

package/gen/google/protobuf/timestamp.ts

@@ -0,0 +1,118 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.10.1
+//   protoc               v3.21.12
+// source: google/protobuf/timestamp.proto
+
+/* eslint-disable */
+
+export const protobufPackage = "google.protobuf";
+
+/**
+ * A Timestamp represents a point in time independent of any time zone or local
+ * calendar, encoded as a count of seconds and fractions of seconds at
+ * nanosecond resolution. The count is relative to an epoch at UTC midnight on
+ * January 1, 1970, in the proleptic Gregorian calendar which extends the
+ * Gregorian calendar backwards to year one.
+ *
+ * All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
+ * second table is needed for interpretation, using a [24-hour linear
+ * smear](https://developers.google.com/time/smear).
+ *
+ * The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
+ * restricting to that range, we ensure that we can convert to and from [RFC
+ * 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
+ *
+ * # Examples
+ *
+ * Example 1: Compute Timestamp from POSIX `time()`.
+ *
+ *     Timestamp timestamp;
+ *     timestamp.set_seconds(time(NULL));
+ *     timestamp.set_nanos(0);
+ *
+ * Example 2: Compute Timestamp from POSIX `gettimeofday()`.
+ *
+ *     struct timeval tv;
+ *     gettimeofday(&tv, NULL);
+ *
+ *     Timestamp timestamp;
+ *     timestamp.set_seconds(tv.tv_sec);
+ *     timestamp.set_nanos(tv.tv_usec * 1000);
+ *
+ * Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
+ *
+ *     FILETIME ft;
+ *     GetSystemTimeAsFileTime(&ft);
+ *     UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
+ *
+ *     // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
+ *     // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
+ *     Timestamp timestamp;
+ *     timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
+ *     timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
+ *
+ * Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
+ *
+ *     long millis = System.currentTimeMillis();
+ *
+ *     Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
+ *         .setNanos((int) ((millis % 1000) * 1000000)).build();
+ *
+ * Example 5: Compute Timestamp from Java `Instant.now()`.
+ *
+ *     Instant now = Instant.now();
+ *
+ *     Timestamp timestamp =
+ *         Timestamp.newBuilder().setSeconds(now.getEpochSecond())
+ *             .setNanos(now.getNano()).build();
+ *
+ * Example 6: Compute Timestamp from current time in Python.
+ *
+ *     timestamp = Timestamp()
+ *     timestamp.GetCurrentTime()
+ *
+ * # JSON Mapping
+ *
+ * In JSON format, the Timestamp type is encoded as a string in the
+ * [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
+ * format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
+ * where {year} is always expressed using four digits while {month}, {day},
+ * {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
+ * seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
+ * are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
+ * is required. A proto3 JSON serializer should always use UTC (as indicated by
+ * "Z") when printing the Timestamp type and a proto3 JSON parser should be
+ * able to accept both UTC and other timezones (as indicated by an offset).
+ *
+ * For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
+ * 01:30 UTC on January 15, 2017.
+ *
+ * In JavaScript, one can convert a Date object to this format using the
+ * standard
+ * [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
+ * method. In Python, a standard `datetime.datetime` object can be converted
+ * to this format using
+ * [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
+ * the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
+ * the Joda Time's [`ISODateTimeFormat.dateTime()`](
+ * http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
+ * ) to obtain a formatter capable of generating timestamps in this format.
+ */
+export interface Timestamp {
+  /**
+   * Represents seconds of UTC time since Unix epoch
+   * 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
+   * 9999-12-31T23:59:59Z inclusive.
+   */
+  seconds: number;
+  /**
+   * Non-negative fractions of a second at nanosecond resolution. Negative
+   * second values with fractions must still have non-negative nanos values
+   * that count forward in time. Must be from 0 to 999,999,999
+   * inclusive.
+   */
+  nanos: number;
+}
+
+export const GOOGLE_PROTOBUF_PACKAGE_NAME = "google.protobuf";

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@astromonacinema/contracts",
+  "version": "1.0.0",
+  "license": "MIT",
+  "description": "Protobuf contracts for microservices",
+  "scripts": {
+    "generate": "protoc -I ./proto ./proto/*.proto --ts_proto_out=./gen --ts_proto_opt=nestJs=true,package=omit"
+  },
+  "files": [
+    "proto",
+    "gen"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@nestjs/microservices": "^11.1.11",
+    "protobufjs": "^8.0.0",
+    "rxjs": "^7.8.2",
+    "ts-proto": "^2.10.1"
+  }
+}

package/proto/auth.proto

@@ -0,0 +1,75 @@
+syntax = "proto3";
+
+package auth.v1;
+
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/struct.proto";
+import "google/protobuf/any.proto";
+
+service AuthService {
+  rpc SendOtp (SendOtpRequest) returns (SendOtpResponse);
+}
+
+message SendOtpRequest {
+  string identifier = 1;
+  string type = 2;
+}
+
+message SendOtpResponse {
+  bool ok = 1;
+}
+
+
+/* Для пояснений типов */
+
+message UserSession {
+  string id = 1;
+  google.protobuf.Timestamp created_at = 3; // временное значение
+  google.protobuf.Struct data = 4; // структура данных JSON формата
+  google.protobuf.Any anyData = 5; // структура данных любого формата
+}
+
+// Сообщение профиля пользователя
+message UserProfile {
+  // id - строка (string): текстовый идентификатор переменной длины, UTF-8
+  string id = 1;
+
+  // age - 32-битное целое число со знаком (int32): диапазон от -2,147,483,648 до 2,147,483,647
+  int32 age = 2;
+
+  // rating - число двойной точности (double): 64-битное число с плавающей точкой, IEEE 754
+  double rating = 3;
+
+  // verified - булево значение (bool): true или false, занимает 1 байт
+  bool verified = 4;
+
+  // roles - повторяющееся поле строк (repeated string): массив строковых значений, может быть пустым или содержать множество элементов
+  repeated string roles = 5;
+
+  // meta - словарь строка-строка (map<string, string>): ключ и значение - строки, неупорядоченная коллекция пар ключ-значение
+  map<string, string> meta = 6;
+
+  // status - перечисление (Status): одно из предопределенных значений enum Status, хранится как int32
+  Status status = 7;
+
+  // contact - oneof (выбор одного из): позволяет задать только одно поле из группы, взаимоисключающие варианты контакта
+  oneof contact {
+    // phone - строка (string): номер телефона, будет установлен только если email не задан
+    string phone = 8;
+
+    // email - строка (string): электронная почта, будет установлен только если phone не задан
+    string email = 9;
+  }
+}
+
+// Перечисление статусов
+enum Status {
+  // STATUS_UNKNOWN - значение по умолчанию (0): всегда первое значение в enum должно быть 0
+  STATUS_UNKNOWN = 0;
+
+  // STATUS_ACTIVE - целочисленная константа (1): активный статус
+  STATUS_ACTIVE = 1;
+
+  // STATUS_BANNED - целочисленная константа (2): заблокированный статус
+  STATUS_BANNED = 2;
+}