ydb-embedded-ui 4.33.0 → 5.1.0

package/dist/types/api/consumer.d.ts

@@ -0,0 +1,215 @@
+import { IProtobufTimeObject } from './common';
+/**
+ * endpoint: /json/describe_consumer
+ *
+ * source: https://github.com/ydb-platform/ydb/blob/main/ydb/public/api/protos/ydb_topic.proto
+ *
+ * Original proto file doesn't specify optional fields, so every field is considered optional
+ */
+export interface DescribeConsumerResult {
+    self?: Entry;
+    consumer?: Consumer;
+    partitions?: PartitionInfo[];
+}
+/** Partition info types differs for consumer and topic, although they are very similar */
+export interface PartitionInfo {
+    /** int64  */
+    partition_id?: string;
+    /** Is partition open for write. */
+    active?: boolean;
+    /**
+     * int64
+     *
+     * Ids of partitions which was formed when this partition was split or merged.
+     */
+    child_partition_ids?: string[];
+    /**
+     * int64
+     *
+     * Ids of partitions from which this partition was formed by split or merge.
+     */
+    parent_partition_ids?: string[];
+    /** Stats for partition, filled only when include_stats in request is true. */
+    partition_stats?: PartitionStats;
+    /** Stats for consumer of this partition, filled only when include_stats in request is true. */
+    partition_consumer_stats?: PartitionConsumerStats;
+}
+interface PartitionConsumerStats {
+    /**
+     * int64
+     *
+     * Last read offset from this partition.
+     */
+    last_read_offset?: string;
+    /**
+     * int64
+     *
+     * Committed offset for this partition.
+     */
+    committed_offset?: string;
+    /** Reading this partition read session identifier. */
+    read_session_id?: string;
+    /**
+     * google.protobuf.Timestamp
+     *
+     * Timestamp of providing this partition to this session by server.
+     */
+    partition_read_session_create_time?: string | IProtobufTimeObject;
+    /**
+     * google.protobuf.Timestamp
+     *
+     * Timestamp of last read from this partition. */
+    last_read_time?: string | IProtobufTimeObject;
+    /**
+     * google.protobuf.Duration
+     *
+     * Maximum of differences between timestamp of read and write timestamp for all messages, read during last minute.
+     */
+    max_read_time_lag?: string | IProtobufTimeObject;
+    /**
+     * google.protobuf.Duration
+     *
+     * Maximum of differences between write timestamp and create timestamp for all messages, read during last minute.
+     */
+    max_write_time_lag?: string | IProtobufTimeObject;
+    /** How much bytes were read during several windows statistics from this partiton. */
+    bytes_read?: MultipleWindowsStat;
+    /** Read session name, provided by client. */
+    reader_name?: string;
+    /** Host where read session connected. */
+    connection_node_id?: number;
+}
+export interface PartitionStats {
+    /** Partition contains messages with offsets in range [start, end). */
+    partition_offsets?: OffsetsRange;
+    /**
+     * int64
+     *
+     * Approximate size of partition.
+     */
+    store_size_bytes?: string;
+    /**
+     * google.protobuf.Timestamp
+     *
+     * Timestamp of last write.
+     */
+    last_write_time?: string | IProtobufTimeObject;
+    /**
+     * google.protobuf.Duration
+     *
+     * Maximum of differences between write timestamp and create timestamp for all messages, written during last minute.
+     */
+    max_write_time_lag?: string | IProtobufTimeObject;
+    /** How much bytes were written during several windows in this partition. */
+    bytes_written?: MultipleWindowsStat;
+    /** Host where tablet for this partition works. Useful for debugging purposes. */
+    partition_node_id?: number;
+}
+interface OffsetsRange {
+    /** int64  */
+    start?: string;
+    /** int64  */
+    end?: string;
+}
+export interface Consumer {
+    /** Must have valid not empty name as a key. */
+    name?: string;
+    /** Consumer may be marked as 'important'. It means messages for this consumer will never expire due to retention. */
+    important?: boolean;
+    /**
+     * google.protobuf.Timestamp
+     *
+     * All messages with smaller server written_at timestamp will be skipped.
+     */
+    read_from?: string | IProtobufTimeObject;
+    /**
+     * List of supported codecs by this consumer.
+     *
+     * supported_codecs on topic must be contained inside this list.
+     */
+    supported_codecs?: SupportedCodecs;
+    /** Attributes of consumer */
+    attributes?: Record<string, string>;
+    /** Filled only when requested statistics in Describe*Request. */
+    consumer_stats?: ConsumerStats;
+}
+interface ConsumerStats {
+    /**
+     * google.protobuf.Timestamp
+     *
+     * Minimal timestamp of last read from partitions.
+     */
+    min_partitions_last_read_time?: string | IProtobufTimeObject;
+    /**
+     * google.protobuf.Duration
+     *
+     * Maximum of differences between timestamp of read and write timestamp for all messages, read during last minute.
+     */
+    max_read_time_lag?: string | IProtobufTimeObject;
+    /**
+     * google.protobuf.Duration
+     *
+     * Maximum of differences between write timestamp and create timestamp for all messages, read during last minute.
+     */
+    max_write_time_lag?: string | IProtobufTimeObject;
+    /** Bytes read stastics. */
+    bytes_read?: MultipleWindowsStat;
+}
+export interface MultipleWindowsStat {
+    /** int64  */
+    per_minute?: string;
+    /** int64  */
+    per_hour?: string;
+    /** int64  */
+    per_day?: string;
+}
+export interface SupportedCodecs {
+    /** List of supported codecs. */
+    codecs?: number[];
+}
+export interface Entry {
+    /** For consumer will be topic-name/consumer-name */
+    name?: string;
+    owner?: string;
+    type?: Type;
+    effective_permissions?: Permissions[];
+    permissions?: Permissions[];
+    /**
+     * uint64
+     *
+     * Size of entry in bytes. Currently filled for:
+     * - TABLE;
+     * - DATABASE.
+     *
+     * Empty (zero) in other cases.
+     */
+    size_bytes?: string;
+    /** Virtual timestamp when the object was created */
+    created_at?: VirtualTimestamp;
+}
+interface Permissions {
+    subject?: string;
+    permission_names?: string[];
+}
+interface VirtualTimestamp {
+    /** uint64 */
+    plan_step?: string;
+    /** uint64 */
+    tx_id?: string;
+}
+declare enum Type {
+    TYPE_UNSPECIFIED = "TYPE_UNSPECIFIED",
+    DIRECTORY = "DIRECTORY",
+    TABLE = "TABLE",
+    PERS_QUEUE_GROUP = "PERS_QUEUE_GROUP",
+    DATABASE = "DATABASE",
+    RTMR_VOLUME = "RTMR_VOLUME",
+    BLOCK_STORE_VOLUME = "BLOCK_STORE_VOLUME",
+    COORDINATION_NODE = "COORDINATION_NODE",
+    COLUMN_STORE = "COLUMN_STORE ",
+    COLUMN_TABLE = "COLUMN_TABLE ",
+    SEQUENCE = "SEQUENCE ",
+    REPLICATION = "REPLICATION ",
+    TOPIC = "TOPIC "
+}
+export {};

package/dist/types/api/consumer.js

@@ -0,0 +1,18 @@
+/* eslint-disable camelcase */
+var Type;
+(function (Type) {
+    Type["TYPE_UNSPECIFIED"] = "TYPE_UNSPECIFIED";
+    Type["DIRECTORY"] = "DIRECTORY";
+    Type["TABLE"] = "TABLE";
+    Type["PERS_QUEUE_GROUP"] = "PERS_QUEUE_GROUP";
+    Type["DATABASE"] = "DATABASE";
+    Type["RTMR_VOLUME"] = "RTMR_VOLUME";
+    Type["BLOCK_STORE_VOLUME"] = "BLOCK_STORE_VOLUME";
+    Type["COORDINATION_NODE"] = "COORDINATION_NODE";
+    Type["COLUMN_STORE"] = "COLUMN_STORE ";
+    Type["COLUMN_TABLE"] = "COLUMN_TABLE ";
+    Type["SEQUENCE"] = "SEQUENCE ";
+    Type["REPLICATION"] = "REPLICATION ";
+    Type["TOPIC"] = "TOPIC ";
+})(Type || (Type = {}));
+export {};

package/dist/types/api/enums.d.ts

@@ -0,0 +1,7 @@
+export declare enum EFlag {
+    Grey = "Grey",
+    Green = "Green",
+    Yellow = "Yellow",
+    Orange = "Orange",
+    Red = "Red"
+}

package/dist/types/api/enums.js

@@ -0,0 +1,11 @@
+// Shows system status
+// Currently is used in response types viewer/json/ storage, nodes, compute
+// pdiskinfo, vdiskinfo, tabletinfo, tenantinfo
+export var EFlag;
+(function (EFlag) {
+    EFlag["Grey"] = "Grey";
+    EFlag["Green"] = "Green";
+    EFlag["Yellow"] = "Yellow";
+    EFlag["Orange"] = "Orange";
+    EFlag["Red"] = "Red";
+})(EFlag || (EFlag = {}));

package/dist/types/api/error.d.ts

@@ -0,0 +1,21 @@
+export interface IResponseError<T = unknown> {
+    data?: T;
+    status?: number;
+    statusText?: string;
+    isCancelled?: boolean;
+}
+export interface NetworkError {
+    code?: unknown;
+    columnNumber?: unknown;
+    config?: Record<string, unknown>;
+    description?: unknown;
+    fileName?: unknown;
+    lineNumber?: unknown;
+    message?: 'Network Error';
+    name?: string;
+    number?: unknown;
+    stack?: string;
+}
+export declare type AuthErrorResponse = IResponseError<{
+    error?: string;
+}>;

package/dist/types/api/error.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api/healthcheck.d.ts

@@ -0,0 +1,76 @@
+export declare enum SelfCheckResult {
+    UNSPECIFIED = "UNSPECIFIED",
+    GOOD = "GOOD",
+    DEGRADED = "DEGRADED",
+    MAINTENANCE_REQUIRED = "MAINTENANCE_REQUIRED",
+    EMERGENCY = "EMERGENCY"
+}
+export declare enum StatusFlag {
+    UNSPECIFIED = "UNSPECIFIED",
+    GREY = "GREY",
+    GREEN = "GREEN",
+    BLUE = "BLUE",
+    YELLOW = "YELLOW",
+    ORANGE = "ORANGE",
+    RED = "RED"
+}
+interface LocationNode {
+    id: number;
+    host: string;
+    port: number;
+}
+interface LocationStoragePDisk {
+    id: string;
+    path: string;
+}
+interface LocationStorageVDisk {
+    id: string;
+    pdisk: LocationStoragePDisk;
+}
+interface LocationStorageGroup {
+    id: string;
+    vdisk: LocationStorageVDisk;
+}
+interface LocationStoragePool {
+    name: string;
+    group: LocationStorageGroup;
+}
+interface LocationStorage {
+    node: LocationNode;
+    pool: LocationStoragePool;
+}
+interface LocationComputePool {
+    name: string;
+}
+interface LocationComputeTablet {
+    type: string;
+    id?: string[];
+    count: number;
+}
+interface LocationCompute {
+    node: LocationNode;
+    pool: LocationComputePool;
+    tablet: LocationComputeTablet;
+}
+interface LocationDatabase {
+    name: string;
+}
+interface Location {
+    storage: LocationStorage;
+    compute: LocationCompute;
+    database: LocationDatabase;
+}
+export interface IssueLog {
+    id: string;
+    status: StatusFlag;
+    message: string;
+    location: Location;
+    reason?: string[];
+    type: string;
+    level: number;
+}
+export interface HealthCheckAPIResponse {
+    self_check_result: SelfCheckResult;
+    issue_log?: IssueLog[];
+}
+export {};

package/dist/types/api/healthcheck.js

@@ -0,0 +1,18 @@
+export var SelfCheckResult;
+(function (SelfCheckResult) {
+    SelfCheckResult["UNSPECIFIED"] = "UNSPECIFIED";
+    SelfCheckResult["GOOD"] = "GOOD";
+    SelfCheckResult["DEGRADED"] = "DEGRADED";
+    SelfCheckResult["MAINTENANCE_REQUIRED"] = "MAINTENANCE_REQUIRED";
+    SelfCheckResult["EMERGENCY"] = "EMERGENCY";
+})(SelfCheckResult || (SelfCheckResult = {}));
+export var StatusFlag;
+(function (StatusFlag) {
+    StatusFlag["UNSPECIFIED"] = "UNSPECIFIED";
+    StatusFlag["GREY"] = "GREY";
+    StatusFlag["GREEN"] = "GREEN";
+    StatusFlag["BLUE"] = "BLUE";
+    StatusFlag["YELLOW"] = "YELLOW";
+    StatusFlag["ORANGE"] = "ORANGE";
+    StatusFlag["RED"] = "RED";
+})(StatusFlag || (StatusFlag = {}));

package/dist/types/api/hotkeys.d.ts

@@ -0,0 +1,7 @@
+export interface JsonHotKeysResponse {
+    hotkeys: HotKey[] | null;
+}
+export interface HotKey {
+    accessSample: number;
+    keyValues: string[];
+}

package/dist/types/api/hotkeys.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api/meta.d.ts

@@ -0,0 +1,46 @@
+import type { TClusterInfo } from './cluster';
+import type { TTenant } from './tenant';
+/**
+ * endpoint: /api/meta/meta/clusters
+ */
+export interface MetaClusters {
+    clusters?: MetaExtendedClusterInfo[];
+}
+export interface MetaCluster {
+    cluster?: MetaGeneralClusterInfo;
+}
+export interface MetaTenants {
+    databases?: TTenant[];
+}
+/** With fields present only in /api/meta/meta/clusters */
+export interface MetaExtendedClusterInfo extends MetaGeneralClusterInfo {
+    hosts?: Record<string, number>;
+    versions?: MetaClusterVersion[];
+}
+export interface MetaGeneralClusterInfo {
+    owner?: string;
+    location?: string;
+    image?: string;
+    title?: string;
+    endpoint?: string;
+    mvp_token?: string;
+    name?: string;
+    solomon?: string;
+    status?: string;
+    scale?: number;
+    environment?: string;
+    control_plane?: string;
+    description?: string;
+    balancer?: string;
+    service?: string;
+    cluster?: MetaViewerClusterInfo;
+}
+export interface MetaViewerClusterInfo extends TClusterInfo {
+    error?: string;
+}
+export interface MetaClusterVersion {
+    version: string;
+    version_base_color_index?: number;
+    count: number;
+    role: string;
+}

package/dist/types/api/meta.js

@@ -0,0 +1 @@
+export {};

package/dist/types/api/netInfo.d.ts

@@ -0,0 +1,44 @@
+import type { EFlag } from './enums';
+/**
+ * endpoint: /viewer/json/netinfo
+ *
+ * source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
+ */
+export interface TNetInfo {
+    Overall: EFlag;
+    Tenants?: TNetTenantInfo[];
+}
+interface TNetTenantInfo {
+    Overall: EFlag;
+    Name: string;
+    Nodes?: TNetNodeInfo[];
+}
+interface TNetNodeInfo {
+    NodeId: number;
+    Overall: EFlag;
+    Peers?: TNetNodePeerInfo[];
+    NodeType: ENodeType;
+    DataCenter: string;
+    Rack: string;
+    Host: string;
+    Port: number;
+}
+export interface TNetNodePeerInfo {
+    NodeId: number;
+    PeerName: string;
+    Connected: boolean;
+    ConnectStatus: EFlag;
+    /** uint64 */
+    ChangeTime: string;
+    NodeType: ENodeType;
+    DataCenter: string;
+    Rack: string;
+    Host: string;
+    Port: number;
+}
+declare enum ENodeType {
+    UnknownNodeType = "UnknownNodeType",
+    Static = "Static",
+    Dynamic = "Dynamic"
+}
+export {};

package/dist/types/api/netInfo.js

@@ -0,0 +1,7 @@
+var ENodeType;
+(function (ENodeType) {
+    ENodeType["UnknownNodeType"] = "UnknownNodeType";
+    ENodeType["Static"] = "Static";
+    ENodeType["Dynamic"] = "Dynamic";
+})(ENodeType || (ENodeType = {}));
+export {};

package/dist/types/api/nodes.d.ts

@@ -0,0 +1,114 @@
+import { EFlag } from './enums';
+import { TPDiskStateInfo } from './pdisk';
+import { TTabletStateInfo } from './tablet';
+import { TVDiskStateInfo } from './vdisk';
+/**
+ * endpoint: /viewer/json/nodes
+ *
+ * source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
+ */
+export interface TNodesInfo {
+    Overall?: EFlag;
+    Nodes?: TNodeInfo[];
+    /** uint64 */
+    TotalNodes: string;
+    /** uint64 */
+    FoundNodes: string;
+}
+export interface TNodeInfo {
+    NodeId: number;
+    SystemState: TSystemStateInfo;
+    PDisks?: TPDiskStateInfo[];
+    VDisks?: TVDiskStateInfo[];
+    Tablets?: TTabletStateInfo[];
+}
+/**
+ * source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/node_whiteboard.proto
+ */
+export interface TSystemStateInfo {
+    /** uint64 */
+    StartTime?: string;
+    /** uint64 */
+    ChangeTime?: string;
+    SystemLocation?: TLegacyNodeLocation;
+    /** double */
+    LoadAverage?: number[];
+    NumberOfCpus?: number;
+    SystemState?: EFlag;
+    MessageBusState?: EFlag;
+    GRpcState?: EFlag;
+    NodeId?: number;
+    Count?: number;
+    DataCenterId?: number;
+    DataCenterDescription?: string;
+    DataCenter?: string;
+    RackId?: number;
+    Rack?: string;
+    Host?: string;
+    Version?: string;
+    PoolStats?: TPoolStats[];
+    Endpoints?: TEndpoint[];
+    Roles?: string[];
+    Tenants?: string[];
+    ClusterName?: string;
+    /** uint64 */
+    MemoryUsed?: string;
+    /** uint64 */
+    MemoryLimit?: string;
+    ConfigState?: EConfigState;
+    /** uint64 */
+    MemoryUsedInAlloc?: string;
+    /** double */
+    MaxDiskUsage?: number;
+    Location?: TNodeLocation;
+    /**
+     * int64
+     *
+     * a positive value means the peer is ahead in time; a negative value means it's behind
+     */
+    MaxClockSkewWithPeerUs?: string;
+    MaxClockSkewPeerId?: number;
+    /** uint64 */
+    DisconnectTime?: string;
+    SharedCacheStats?: TNodeSharedCache;
+    TotalSessions?: number;
+}
+export declare type PoolName = 'System' | 'User' | 'Batch' | 'IO' | 'IC';
+export interface TPoolStats {
+    Name?: PoolName;
+    /** double */
+    Usage?: number;
+    Threads?: number;
+}
+export interface TEndpoint {
+    Name?: string;
+    Address?: string;
+}
+export interface TLegacyNodeLocation {
+    DataCenter?: number;
+    Room?: number;
+    Rack?: number;
+    Body?: number;
+}
+interface TNodeLocation {
+    DataCenterNum?: number;
+    RoomNum?: number;
+    RackNum?: number;
+    BodyNum?: number;
+    Body?: number;
+    DataCenter?: string;
+    Module?: string;
+    Rack?: string;
+    Unit?: string;
+}
+interface TNodeSharedCache {
+    /** uint64 */
+    UsedBytes: string;
+    /** uint64 */
+    LimitBytes: string;
+}
+declare enum EConfigState {
+    'Consistent' = "Consistent",
+    'Outdated' = "Outdated"
+}
+export {};

package/dist/types/api/nodes.js

@@ -0,0 +1,6 @@
+var EConfigState;
+(function (EConfigState) {
+    EConfigState["Consistent"] = "Consistent";
+    EConfigState["Outdated"] = "Outdated";
+})(EConfigState || (EConfigState = {}));
+export {};

package/dist/types/api/nodesList.d.ts

@@ -0,0 +1,24 @@
+/**
+ * endpoint: /viewer/json/nodesList
+ *
+ * source: https://github.com/ydb-platform/ydb/blob/main/library/cpp/actors/core/interconnect.h
+ */
+export declare type TEvNodesInfo = TNodeInfo[];
+export interface TNodeInfo {
+    Id?: number;
+    Host?: string;
+    ResolveHost?: string;
+    Address?: string;
+    Port?: number;
+    PhysicalLocation?: TNodeLocation;
+}
+interface TNodeLocation {
+    DataCenter?: number;
+    Room?: number;
+    Rack?: number;
+    Body?: number;
+    DataCenterId?: string;
+    /** String with DC, Module, Rack and Unit ids */
+    Location?: string;
+}
+export {};

package/dist/types/api/nodesList.js

@@ -0,0 +1 @@
+export {};