@marleena/trb-proto 0.1.0 → 0.1.2

package/README.md

@@ -1,14 +1,27 @@
-# @marleena/trb-proto
+# TrB proto
 
-Сгенерированные protobuf-сообщения и gRPC-Web клиенты сервисов TrB.
+Контракты сервисов и сгенерированный код:
 
-## Установка
+- Go — `gen/go`
+- JavaScript / TypeScript (protobuf + gRPC-Web) — npm-пакет [`@marleena/trb-proto`](https://www.npmjs.com/package/@marleena/trb-proto)
+
+## Генерация
+
+Нужны `protoc` и плагины: `protoc-gen-go`, `protoc-gen-go-grpc`, `protoc-gen-grpc-gateway`, `protoc-gen-js`, `protoc-gen-grpc-web`.
 
 ```bash
-npm install @marleena/trb-proto
+make gene
 ```
 
-## Использование
+Собирает Go, JS/TS и descriptor set. Google API-аннотации для JS генерируются отдельно, чтобы не попасть в `gen/go`.
+
+Другие цели: `make desc`, `make buf`.
+
+## npm
+
+```bash
+npm install @marleena/trb-proto
+```
 
 ```ts
 import { MessageRequest } from '@marleena/trb-proto/example/Example_pb';
@@ -19,35 +32,27 @@ const req = new MessageRequest();
 req.setText('hello');
 ```
 
-Другие сервисы: `tinvest`, `nats`, `moex`, `clickhouse`, `manager_indicators`.
+Сервисы: `example`, `tinvest`, `nats`, `moex`, `clickhouse`, `manager_indicators`, `db_api`.
 
-## Публикация
+`db_api` (`trb.db.api.public.contract.v1.DbApi`) — gRPC API веб-клиента к ClickHouse и Postgres. Новый метод добавляется RPC-ом в `services/db_api/db_api.proto`.
 
-Через код 2FA:
+## Публикация
 
 ```bash
 make gene
 make login
-make publish OTP=123456
+make publish
 ```
 
-Через Access Token:
-
-1. [Create Granular Access Token](https://www.npmjs.com/settings/marleena/tokens/create)
-2. Permissions: **Read and write**
-3. Packages: `@marleena/trb-proto` (или весь scope `@marleena`)
-4. Включить **Bypass 2FA / Bypass two-factor authentication**
-5. Скопировать токен (`npm_...`) и опубликовать:
+Если `make` не спрашивает 2FA (часто на Windows):
 
 ```bash
-make logout
-make publish TOKEN=npm_ваш_токен
+make publish OTP=123456
 ```
 
-Сессию `npm login` нужно сбросить (`make logout`), иначе npm игнорирует токен.
-
-Для GitHub Packages добавьте в `.npmrc`:
+Через [granular token](https://www.npmjs.com/settings/marleena/tokens/create) (Read and write + Bypass 2FA):
 
-```
-@marleena:registry=https://npm.pkg.github.com
+```bash
+make logout
+make publish TOKEN=npm_...
 ```

package/gen/js-ts/clickhouse/Clickhouse_grpcServiceClientPb.ts

@@ -0,0 +1,108 @@
+/**
+ * @fileoverview gRPC-Web generated client stub for clickhouse.grpc
+ * @enhanceable
+ * @public
+ */
+
+// Code generated by protoc-gen-grpc-web. DO NOT EDIT.
+// versions:
+// 	protoc-gen-grpc-web v1.5.0
+// 	protoc              v7.34.1
+// source: clickhouse/clickhouse_grpc.proto
+
+
+/* eslint-disable */
+// @ts-nocheck
+
+
+import * as grpcWeb from 'grpc-web';
+
+import * as clickhouse_clickhouse_grpc_pb from '../clickhouse/clickhouse_grpc_pb'; // proto import: "clickhouse/clickhouse_grpc.proto"
+
+
+export class ClickHouseClient {
+  client_: grpcWeb.AbstractClientBase;
+  hostname_: string;
+  credentials_: null | { [index: string]: string; };
+  options_: null | { [index: string]: any; };
+
+  constructor (hostname: string,
+               credentials?: null | { [index: string]: string; },
+               options?: null | { [index: string]: any; }) {
+    if (!options) options = {};
+    if (!credentials) credentials = {};
+    options['format'] = 'binary';
+
+    this.client_ = new grpcWeb.GrpcWebClientBase(options);
+    this.hostname_ = hostname.replace(/\/+$/, '');
+    this.credentials_ = credentials;
+    this.options_ = options;
+  }
+
+  methodDescriptorExecuteQuery = new grpcWeb.MethodDescriptor(
+    '/clickhouse.grpc.ClickHouse/ExecuteQuery',
+    grpcWeb.MethodType.UNARY,
+    clickhouse_clickhouse_grpc_pb.QueryInfo,
+    clickhouse_clickhouse_grpc_pb.Result,
+    (request: clickhouse_clickhouse_grpc_pb.QueryInfo) => {
+      return request.serializeBinary();
+    },
+    clickhouse_clickhouse_grpc_pb.Result.deserializeBinary
+  );
+
+  executeQuery(
+    request: clickhouse_clickhouse_grpc_pb.QueryInfo,
+    metadata?: grpcWeb.Metadata | null): Promise<clickhouse_clickhouse_grpc_pb.Result>;
+
+  executeQuery(
+    request: clickhouse_clickhouse_grpc_pb.QueryInfo,
+    metadata: grpcWeb.Metadata | null,
+    callback: (err: grpcWeb.RpcError,
+               response: clickhouse_clickhouse_grpc_pb.Result) => void): grpcWeb.ClientReadableStream<clickhouse_clickhouse_grpc_pb.Result>;
+
+  executeQuery(
+    request: clickhouse_clickhouse_grpc_pb.QueryInfo,
+    metadata?: grpcWeb.Metadata | null,
+    callback?: (err: grpcWeb.RpcError,
+               response: clickhouse_clickhouse_grpc_pb.Result) => void) {
+    if (callback !== undefined) {
+      return this.client_.rpcCall(
+        this.hostname_ +
+          '/clickhouse.grpc.ClickHouse/ExecuteQuery',
+        request,
+        metadata || {},
+        this.methodDescriptorExecuteQuery,
+        callback);
+    }
+    return this.client_.unaryCall(
+    this.hostname_ +
+      '/clickhouse.grpc.ClickHouse/ExecuteQuery',
+    request,
+    metadata || {},
+    this.methodDescriptorExecuteQuery);
+  }
+
+  methodDescriptorExecuteQueryWithStreamOutput = new grpcWeb.MethodDescriptor(
+    '/clickhouse.grpc.ClickHouse/ExecuteQueryWithStreamOutput',
+    grpcWeb.MethodType.SERVER_STREAMING,
+    clickhouse_clickhouse_grpc_pb.QueryInfo,
+    clickhouse_clickhouse_grpc_pb.Result,
+    (request: clickhouse_clickhouse_grpc_pb.QueryInfo) => {
+      return request.serializeBinary();
+    },
+    clickhouse_clickhouse_grpc_pb.Result.deserializeBinary
+  );
+
+  executeQueryWithStreamOutput(
+    request: clickhouse_clickhouse_grpc_pb.QueryInfo,
+    metadata?: grpcWeb.Metadata): grpcWeb.ClientReadableStream<clickhouse_clickhouse_grpc_pb.Result> {
+    return this.client_.serverStreaming(
+      this.hostname_ +
+        '/clickhouse.grpc.ClickHouse/ExecuteQueryWithStreamOutput',
+      request,
+      metadata || {},
+      this.methodDescriptorExecuteQueryWithStreamOutput);
+  }
+
+}
+

package/gen/js-ts/clickhouse/clickhouse_grpc_pb.d.ts

@@ -0,0 +1,464 @@
+import * as jspb from 'google-protobuf'
+
+import * as google_api_annotations_pb from '../google/api/annotations_pb'; // proto import: "google/api/annotations.proto"
+
+
+export class NameAndType extends jspb.Message {
+  getName(): string;
+  setName(value: string): NameAndType;
+
+  getType(): string;
+  setType(value: string): NameAndType;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): NameAndType.AsObject;
+  static toObject(includeInstance: boolean, msg: NameAndType): NameAndType.AsObject;
+  static serializeBinaryToWriter(message: NameAndType, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): NameAndType;
+  static deserializeBinaryFromReader(message: NameAndType, reader: jspb.BinaryReader): NameAndType;
+}
+
+export namespace NameAndType {
+  export type AsObject = {
+    name: string,
+    type: string,
+  }
+}
+
+export class ExternalTable extends jspb.Message {
+  getName(): string;
+  setName(value: string): ExternalTable;
+
+  getColumnsList(): Array<NameAndType>;
+  setColumnsList(value: Array<NameAndType>): ExternalTable;
+  clearColumnsList(): ExternalTable;
+  addColumns(value?: NameAndType, index?: number): NameAndType;
+
+  getData(): Uint8Array | string;
+  getData_asU8(): Uint8Array;
+  getData_asB64(): string;
+  setData(value: Uint8Array | string): ExternalTable;
+
+  getFormat(): string;
+  setFormat(value: string): ExternalTable;
+
+  getCompressionType(): string;
+  setCompressionType(value: string): ExternalTable;
+
+  getSettingsMap(): jspb.Map<string, string>;
+  clearSettingsMap(): ExternalTable;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): ExternalTable.AsObject;
+  static toObject(includeInstance: boolean, msg: ExternalTable): ExternalTable.AsObject;
+  static serializeBinaryToWriter(message: ExternalTable, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): ExternalTable;
+  static deserializeBinaryFromReader(message: ExternalTable, reader: jspb.BinaryReader): ExternalTable;
+}
+
+export namespace ExternalTable {
+  export type AsObject = {
+    name: string,
+    columnsList: Array<NameAndType.AsObject>,
+    data: Uint8Array | string,
+    format: string,
+    compressionType: string,
+    settingsMap: Array<[string, string]>,
+  }
+}
+
+export class ObsoleteTransportCompression extends jspb.Message {
+  getAlgorithm(): ObsoleteTransportCompression.CompressionAlgorithm;
+  setAlgorithm(value: ObsoleteTransportCompression.CompressionAlgorithm): ObsoleteTransportCompression;
+
+  getLevel(): ObsoleteTransportCompression.CompressionLevel;
+  setLevel(value: ObsoleteTransportCompression.CompressionLevel): ObsoleteTransportCompression;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): ObsoleteTransportCompression.AsObject;
+  static toObject(includeInstance: boolean, msg: ObsoleteTransportCompression): ObsoleteTransportCompression.AsObject;
+  static serializeBinaryToWriter(message: ObsoleteTransportCompression, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): ObsoleteTransportCompression;
+  static deserializeBinaryFromReader(message: ObsoleteTransportCompression, reader: jspb.BinaryReader): ObsoleteTransportCompression;
+}
+
+export namespace ObsoleteTransportCompression {
+  export type AsObject = {
+    algorithm: ObsoleteTransportCompression.CompressionAlgorithm,
+    level: ObsoleteTransportCompression.CompressionLevel,
+  }
+
+  export enum CompressionAlgorithm { 
+    NO_COMPRESSION = 0,
+    DEFLATE = 1,
+    GZIP = 2,
+    STREAM_GZIP = 3,
+  }
+
+  export enum CompressionLevel { 
+    COMPRESSION_NONE = 0,
+    COMPRESSION_LOW = 1,
+    COMPRESSION_MEDIUM = 2,
+    COMPRESSION_HIGH = 3,
+  }
+}
+
+export class QueryInfo extends jspb.Message {
+  getQuery(): string;
+  setQuery(value: string): QueryInfo;
+
+  getQueryId(): string;
+  setQueryId(value: string): QueryInfo;
+
+  getSettingsMap(): jspb.Map<string, string>;
+  clearSettingsMap(): QueryInfo;
+
+  getDatabase(): string;
+  setDatabase(value: string): QueryInfo;
+
+  getInputData(): Uint8Array | string;
+  getInputData_asU8(): Uint8Array;
+  getInputData_asB64(): string;
+  setInputData(value: Uint8Array | string): QueryInfo;
+
+  getInputDataDelimiter(): Uint8Array | string;
+  getInputDataDelimiter_asU8(): Uint8Array;
+  getInputDataDelimiter_asB64(): string;
+  setInputDataDelimiter(value: Uint8Array | string): QueryInfo;
+
+  getOutputFormat(): string;
+  setOutputFormat(value: string): QueryInfo;
+
+  getSendOutputColumns(): boolean;
+  setSendOutputColumns(value: boolean): QueryInfo;
+
+  getExternalTablesList(): Array<ExternalTable>;
+  setExternalTablesList(value: Array<ExternalTable>): QueryInfo;
+  clearExternalTablesList(): QueryInfo;
+  addExternalTables(value?: ExternalTable, index?: number): ExternalTable;
+
+  getUserName(): string;
+  setUserName(value: string): QueryInfo;
+
+  getPassword(): string;
+  setPassword(value: string): QueryInfo;
+
+  getQuota(): string;
+  setQuota(value: string): QueryInfo;
+
+  getJwt(): string;
+  setJwt(value: string): QueryInfo;
+
+  getSessionId(): string;
+  setSessionId(value: string): QueryInfo;
+
+  getSessionCheck(): boolean;
+  setSessionCheck(value: boolean): QueryInfo;
+
+  getSessionTimeout(): number;
+  setSessionTimeout(value: number): QueryInfo;
+
+  getCancel(): boolean;
+  setCancel(value: boolean): QueryInfo;
+
+  getNextQueryInfo(): boolean;
+  setNextQueryInfo(value: boolean): QueryInfo;
+
+  getInputCompressionType(): string;
+  setInputCompressionType(value: string): QueryInfo;
+
+  getOutputCompressionType(): string;
+  setOutputCompressionType(value: string): QueryInfo;
+
+  getOutputCompressionLevel(): number;
+  setOutputCompressionLevel(value: number): QueryInfo;
+
+  getTransportCompressionType(): string;
+  setTransportCompressionType(value: string): QueryInfo;
+
+  getTransportCompressionLevel(): number;
+  setTransportCompressionLevel(value: number): QueryInfo;
+
+  getObsoleteResultCompression(): ObsoleteTransportCompression | undefined;
+  setObsoleteResultCompression(value?: ObsoleteTransportCompression): QueryInfo;
+  hasObsoleteResultCompression(): boolean;
+  clearObsoleteResultCompression(): QueryInfo;
+
+  getObsoleteCompressionType(): string;
+  setObsoleteCompressionType(value: string): QueryInfo;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): QueryInfo.AsObject;
+  static toObject(includeInstance: boolean, msg: QueryInfo): QueryInfo.AsObject;
+  static serializeBinaryToWriter(message: QueryInfo, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): QueryInfo;
+  static deserializeBinaryFromReader(message: QueryInfo, reader: jspb.BinaryReader): QueryInfo;
+}
+
+export namespace QueryInfo {
+  export type AsObject = {
+    query: string,
+    queryId: string,
+    settingsMap: Array<[string, string]>,
+    database: string,
+    inputData: Uint8Array | string,
+    inputDataDelimiter: Uint8Array | string,
+    outputFormat: string,
+    sendOutputColumns: boolean,
+    externalTablesList: Array<ExternalTable.AsObject>,
+    userName: string,
+    password: string,
+    quota: string,
+    jwt: string,
+    sessionId: string,
+    sessionCheck: boolean,
+    sessionTimeout: number,
+    cancel: boolean,
+    nextQueryInfo: boolean,
+    inputCompressionType: string,
+    outputCompressionType: string,
+    outputCompressionLevel: number,
+    transportCompressionType: string,
+    transportCompressionLevel: number,
+    obsoleteResultCompression?: ObsoleteTransportCompression.AsObject,
+    obsoleteCompressionType: string,
+  }
+}
+
+export class LogEntry extends jspb.Message {
+  getTime(): number;
+  setTime(value: number): LogEntry;
+
+  getTimeMicroseconds(): number;
+  setTimeMicroseconds(value: number): LogEntry;
+
+  getThreadId(): number;
+  setThreadId(value: number): LogEntry;
+
+  getQueryId(): string;
+  setQueryId(value: string): LogEntry;
+
+  getLevel(): LogsLevel;
+  setLevel(value: LogsLevel): LogEntry;
+
+  getSource(): string;
+  setSource(value: string): LogEntry;
+
+  getText(): string;
+  setText(value: string): LogEntry;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): LogEntry.AsObject;
+  static toObject(includeInstance: boolean, msg: LogEntry): LogEntry.AsObject;
+  static serializeBinaryToWriter(message: LogEntry, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): LogEntry;
+  static deserializeBinaryFromReader(message: LogEntry, reader: jspb.BinaryReader): LogEntry;
+}
+
+export namespace LogEntry {
+  export type AsObject = {
+    time: number,
+    timeMicroseconds: number,
+    threadId: number,
+    queryId: string,
+    level: LogsLevel,
+    source: string,
+    text: string,
+  }
+}
+
+export class Progress extends jspb.Message {
+  getReadRows(): number;
+  setReadRows(value: number): Progress;
+
+  getReadBytes(): number;
+  setReadBytes(value: number): Progress;
+
+  getTotalRowsToRead(): number;
+  setTotalRowsToRead(value: number): Progress;
+
+  getWrittenRows(): number;
+  setWrittenRows(value: number): Progress;
+
+  getWrittenBytes(): number;
+  setWrittenBytes(value: number): Progress;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): Progress.AsObject;
+  static toObject(includeInstance: boolean, msg: Progress): Progress.AsObject;
+  static serializeBinaryToWriter(message: Progress, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): Progress;
+  static deserializeBinaryFromReader(message: Progress, reader: jspb.BinaryReader): Progress;
+}
+
+export namespace Progress {
+  export type AsObject = {
+    readRows: number,
+    readBytes: number,
+    totalRowsToRead: number,
+    writtenRows: number,
+    writtenBytes: number,
+  }
+}
+
+export class Stats extends jspb.Message {
+  getRows(): number;
+  setRows(value: number): Stats;
+
+  getBlocks(): number;
+  setBlocks(value: number): Stats;
+
+  getAllocatedBytes(): number;
+  setAllocatedBytes(value: number): Stats;
+
+  getAppliedLimit(): boolean;
+  setAppliedLimit(value: boolean): Stats;
+
+  getRowsBeforeLimit(): number;
+  setRowsBeforeLimit(value: number): Stats;
+
+  getAppliedAggregation(): boolean;
+  setAppliedAggregation(value: boolean): Stats;
+
+  getRowsBeforeAggregation(): number;
+  setRowsBeforeAggregation(value: number): Stats;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): Stats.AsObject;
+  static toObject(includeInstance: boolean, msg: Stats): Stats.AsObject;
+  static serializeBinaryToWriter(message: Stats, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): Stats;
+  static deserializeBinaryFromReader(message: Stats, reader: jspb.BinaryReader): Stats;
+}
+
+export namespace Stats {
+  export type AsObject = {
+    rows: number,
+    blocks: number,
+    allocatedBytes: number,
+    appliedLimit: boolean,
+    rowsBeforeLimit: number,
+    appliedAggregation: boolean,
+    rowsBeforeAggregation: number,
+  }
+}
+
+export class Exception extends jspb.Message {
+  getCode(): number;
+  setCode(value: number): Exception;
+
+  getName(): string;
+  setName(value: string): Exception;
+
+  getDisplayText(): string;
+  setDisplayText(value: string): Exception;
+
+  getStackTrace(): string;
+  setStackTrace(value: string): Exception;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): Exception.AsObject;
+  static toObject(includeInstance: boolean, msg: Exception): Exception.AsObject;
+  static serializeBinaryToWriter(message: Exception, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): Exception;
+  static deserializeBinaryFromReader(message: Exception, reader: jspb.BinaryReader): Exception;
+}
+
+export namespace Exception {
+  export type AsObject = {
+    code: number,
+    name: string,
+    displayText: string,
+    stackTrace: string,
+  }
+}
+
+export class Result extends jspb.Message {
+  getQueryId(): string;
+  setQueryId(value: string): Result;
+
+  getTimeZone(): string;
+  setTimeZone(value: string): Result;
+
+  getOutputFormat(): string;
+  setOutputFormat(value: string): Result;
+
+  getOutputColumnsList(): Array<NameAndType>;
+  setOutputColumnsList(value: Array<NameAndType>): Result;
+  clearOutputColumnsList(): Result;
+  addOutputColumns(value?: NameAndType, index?: number): NameAndType;
+
+  getOutput(): Uint8Array | string;
+  getOutput_asU8(): Uint8Array;
+  getOutput_asB64(): string;
+  setOutput(value: Uint8Array | string): Result;
+
+  getTotals(): Uint8Array | string;
+  getTotals_asU8(): Uint8Array;
+  getTotals_asB64(): string;
+  setTotals(value: Uint8Array | string): Result;
+
+  getExtremes(): Uint8Array | string;
+  getExtremes_asU8(): Uint8Array;
+  getExtremes_asB64(): string;
+  setExtremes(value: Uint8Array | string): Result;
+
+  getLogsList(): Array<LogEntry>;
+  setLogsList(value: Array<LogEntry>): Result;
+  clearLogsList(): Result;
+  addLogs(value?: LogEntry, index?: number): LogEntry;
+
+  getProgress(): Progress | undefined;
+  setProgress(value?: Progress): Result;
+  hasProgress(): boolean;
+  clearProgress(): Result;
+
+  getStats(): Stats | undefined;
+  setStats(value?: Stats): Result;
+  hasStats(): boolean;
+  clearStats(): Result;
+
+  getException(): Exception | undefined;
+  setException(value?: Exception): Result;
+  hasException(): boolean;
+  clearException(): Result;
+
+  getCancelled(): boolean;
+  setCancelled(value: boolean): Result;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): Result.AsObject;
+  static toObject(includeInstance: boolean, msg: Result): Result.AsObject;
+  static serializeBinaryToWriter(message: Result, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): Result;
+  static deserializeBinaryFromReader(message: Result, reader: jspb.BinaryReader): Result;
+}
+
+export namespace Result {
+  export type AsObject = {
+    queryId: string,
+    timeZone: string,
+    outputFormat: string,
+    outputColumnsList: Array<NameAndType.AsObject>,
+    output: Uint8Array | string,
+    totals: Uint8Array | string,
+    extremes: Uint8Array | string,
+    logsList: Array<LogEntry.AsObject>,
+    progress?: Progress.AsObject,
+    stats?: Stats.AsObject,
+    exception?: Exception.AsObject,
+    cancelled: boolean,
+  }
+}
+
+export enum LogsLevel { 
+  LOG_NONE = 0,
+  LOG_FATAL = 1,
+  LOG_CRITICAL = 2,
+  LOG_ERROR = 3,
+  LOG_WARNING = 4,
+  LOG_NOTICE = 5,
+  LOG_INFORMATION = 6,
+  LOG_DEBUG = 7,
+  LOG_TRACE = 8,
+}