ydb-embedded-ui 4.33.0 → 5.0.0

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

@@ -0,0 +1,97 @@
+import { EFlag } from './enums';
+import { TVDiskStateInfo } from './vdisk';
+/**
+ * endpoint: /viewer/json/storage
+ *
+ * source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
+ */
+export interface TStorageInfo {
+    Overall?: EFlag;
+    StoragePools?: TStoragePoolInfo[];
+    StorageGroups?: TStorageGroupInfoV2[];
+    /** uint64 */
+    TotalGroups?: string;
+    /** uint64 */
+    FoundGroups?: string;
+}
+export interface TStoragePoolInfo {
+    Overall?: EFlag;
+    Name?: string;
+    Kind?: string;
+    Groups?: TStorageGroupInfo[];
+    /** uint64 */
+    AcquiredUnits?: string;
+    AcquiredIOPS?: number;
+    /** uint64 */
+    AcquiredThroughput?: string;
+    /** uint64 */
+    AcquiredSize?: string;
+    MaximumIOPS?: number;
+    /** uint64 */
+    MaximumThroughput?: string;
+    /** uint64 */
+    MaximumSize?: string;
+}
+export interface TStorageGroupInfoV2 extends TStorageGroupInfo {
+    PoolName?: string;
+    Kind?: string;
+    /** uint64 */
+    Degraded?: string;
+    /** uint64 */
+    Used: string;
+    /** uint64 */
+    Limit: string;
+    /** uint64 */
+    Read: string;
+    /** uint64 */
+    Write: string;
+    /** uint64 */
+    Usage?: string;
+}
+export declare type TStorageGroupInfo = TBSGroupStateInfo & THiveStorageGroupStats;
+interface TBSGroupStateInfo {
+    GroupID?: number;
+    ErasureSpecies?: string;
+    VDisks?: TVDiskStateInfo[];
+    /** uint64 */
+    ChangeTime?: string;
+    NodeId?: number;
+    GroupGeneration?: number;
+    Overall?: EFlag;
+    Latency?: EFlag;
+    Count?: number;
+    StoragePoolName?: string;
+    /** uint64 */
+    AllocatedSize?: string;
+    /** uint64 */
+    AvailableSize?: string;
+    /** uint64 */
+    ReadThroughput?: string;
+    /** uint64 */
+    WriteThroughput?: string;
+    Encryption?: boolean;
+}
+interface THiveStorageGroupStats {
+    GroupID?: number;
+    /** uint64 */
+    AcquiredUnits?: string;
+    AcquiredIOPS?: number;
+    /** uint64 */
+    AcquiredThroughput?: string;
+    /** uint64 */
+    AcquiredSize?: string;
+    MaximumIOPS?: number;
+    /** uint64 */
+    MaximumThroughput?: string;
+    /** uint64 */
+    MaximumSize?: string;
+    /** uint64 */
+    AllocatedSize?: string;
+    /** uint64 */
+    AvailableSize?: string;
+}
+export declare enum EVersion {
+    v1 = "v1",
+    v2 = "v2"
+}
+export {};

package/dist/types/api/storage.js

@@ -0,0 +1,5 @@
+export var EVersion;
+(function (EVersion) {
+    EVersion["v1"] = "v1";
+    EVersion["v2"] = "v2";
+})(EVersion || (EVersion = {}));

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

@@ -0,0 +1,12 @@
+import { TSystemStateInfo } from './nodes';
+/**
+ * endpoint: /viewer/json/sysinfo
+ *
+ * source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/node_whiteboard.proto
+ */
+export interface TEvSystemStateResponse {
+    SystemStateInfo?: TSystemStateInfo[];
+    /** uint64 */
+    ResponseTime?: string;
+    ResponseDuration?: number;
+}

package/dist/types/api/systemState.js

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

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

@@ -0,0 +1,112 @@
+import { EFlag } from './enums';
+/**
+ * endpoint: /viewer/json/tabletinfo
+ *
+ * source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/sys_view.proto
+ */
+export interface TEvTabletStateResponse {
+    TabletStateInfo?: TTabletStateInfo[];
+    /** uint64 */
+    ResponseTime?: string;
+    /** uint64 */
+    ResponseDuration?: string;
+    /** uint64 */
+    ProcessDuration?: string;
+    Packed5?: unknown;
+}
+/**
+ * endpoint: /viewer/json/tabletinfo with merge=false in query.
+ * Maps nodes to their tablets
+ */
+export declare type UnmergedTEvTabletStateResponse = Record<string, TEvTabletStateResponse>;
+export interface TTabletStateInfo {
+    /** uint64 */
+    TabletId?: string;
+    /** uint64 */
+    CreateTime?: string;
+    /** uint64 */
+    ChangeTime?: string;
+    State?: ETabletState;
+    UserState?: number;
+    Generation?: number;
+    Type?: EType;
+    Host?: string;
+    ChannelGroupIDs?: number[];
+    Attributes?: TCustomTabletAttribute[];
+    NodeId?: number;
+    Leader?: boolean;
+    Count?: number;
+    FollowerId?: number;
+    Overall?: EFlag;
+    TenantId?: TDomainKey;
+    /** fixed64 */
+    HiveId?: string;
+}
+interface TCustomTabletAttribute {
+    Key?: number;
+    Value?: string;
+}
+export interface TDomainKey {
+    /** fixed64 */
+    SchemeShard?: string;
+    /** fixed64 */
+    PathId?: string;
+}
+export declare enum EType {
+    'Unknown' = "Unknown",
+    'OldSchemeShard' = "OldSchemeShard",
+    'OldDataShard' = "OldDataShard",
+    'OldHive' = "OldHive",
+    'OldCoordinator' = "OldCoordinator",
+    'Mediator' = "Mediator",
+    'OldTxProxy' = "OldTxProxy",
+    'OldBSController' = "OldBSController",
+    'Dummy' = "Dummy",
+    'RTMRPartition' = "RTMRPartition",
+    'OldKeyValue' = "OldKeyValue",
+    'KeyValue' = "KeyValue",
+    'Coordinator' = "Coordinator",
+    'Hive' = "Hive",
+    'BSController' = "BSController",
+    'SchemeShard' = "SchemeShard",
+    'TxProxy' = "TxProxy",
+    'DataShard' = "DataShard",
+    'PersQueue' = "PersQueue",
+    'Cms' = "Cms",
+    'NodeBroker' = "NodeBroker",
+    'TxAllocator' = "TxAllocator",
+    'PersQueueReadBalancer' = "PersQueueReadBalancer",
+    'BlockStoreVolume' = "BlockStoreVolume",
+    'BlockStorePartition' = "BlockStorePartition",
+    'TenantSlotBroker' = "TenantSlotBroker",
+    'Console' = "Console",
+    'Kesus' = "Kesus",
+    'BlockStorePartition2' = "BlockStorePartition2",
+    'BlockStoreDiskRegistry' = "BlockStoreDiskRegistry",
+    'SysViewProcessor' = "SysViewProcessor",
+    'FileStore' = "FileStore",
+    'ColumnShard' = "ColumnShard",
+    'TestShard' = "TestShard",
+    'SequenceShard' = "SequenceShard",
+    'ReplicationController' = "ReplicationController",
+    'BlobDepot' = "BlobDepot",
+    'UserTypeStart' = "UserTypeStart",
+    'TypeInvalid' = "TypeInvalid"
+}
+export declare enum ETabletState {
+    'Created' = "Created",
+    'ResolveStateStorage' = "ResolveStateStorage",
+    'Candidate' = "Candidate",
+    'BlockBlobStorage' = "BlockBlobStorage",
+    'RebuildGraph' = "RebuildGraph",
+    'WriteZeroEntry' = "WriteZeroEntry",
+    'Restored' = "Restored",
+    'Discover' = "Discover",
+    'Lock' = "Lock",
+    'Dead' = "Dead",
+    'Active' = "Active",
+    'ResolveLeader' = "ResolveLeader",
+    'Deleted' = "Deleted",
+    'Stopped' = "Stopped"
+}
+export {};

package/dist/types/api/tablet.js

@@ -0,0 +1,59 @@
+export var EType;
+(function (EType) {
+    EType["Unknown"] = "Unknown";
+    EType["OldSchemeShard"] = "OldSchemeShard";
+    EType["OldDataShard"] = "OldDataShard";
+    EType["OldHive"] = "OldHive";
+    EType["OldCoordinator"] = "OldCoordinator";
+    EType["Mediator"] = "Mediator";
+    EType["OldTxProxy"] = "OldTxProxy";
+    EType["OldBSController"] = "OldBSController";
+    EType["Dummy"] = "Dummy";
+    EType["RTMRPartition"] = "RTMRPartition";
+    EType["OldKeyValue"] = "OldKeyValue";
+    EType["KeyValue"] = "KeyValue";
+    EType["Coordinator"] = "Coordinator";
+    EType["Hive"] = "Hive";
+    EType["BSController"] = "BSController";
+    EType["SchemeShard"] = "SchemeShard";
+    EType["TxProxy"] = "TxProxy";
+    EType["DataShard"] = "DataShard";
+    EType["PersQueue"] = "PersQueue";
+    EType["Cms"] = "Cms";
+    EType["NodeBroker"] = "NodeBroker";
+    EType["TxAllocator"] = "TxAllocator";
+    EType["PersQueueReadBalancer"] = "PersQueueReadBalancer";
+    EType["BlockStoreVolume"] = "BlockStoreVolume";
+    EType["BlockStorePartition"] = "BlockStorePartition";
+    EType["TenantSlotBroker"] = "TenantSlotBroker";
+    EType["Console"] = "Console";
+    EType["Kesus"] = "Kesus";
+    EType["BlockStorePartition2"] = "BlockStorePartition2";
+    EType["BlockStoreDiskRegistry"] = "BlockStoreDiskRegistry";
+    EType["SysViewProcessor"] = "SysViewProcessor";
+    EType["FileStore"] = "FileStore";
+    EType["ColumnShard"] = "ColumnShard";
+    EType["TestShard"] = "TestShard";
+    EType["SequenceShard"] = "SequenceShard";
+    EType["ReplicationController"] = "ReplicationController";
+    EType["BlobDepot"] = "BlobDepot";
+    EType["UserTypeStart"] = "UserTypeStart";
+    EType["TypeInvalid"] = "TypeInvalid";
+})(EType || (EType = {}));
+export var ETabletState;
+(function (ETabletState) {
+    ETabletState["Created"] = "Created";
+    ETabletState["ResolveStateStorage"] = "ResolveStateStorage";
+    ETabletState["Candidate"] = "Candidate";
+    ETabletState["BlockBlobStorage"] = "BlockBlobStorage";
+    ETabletState["RebuildGraph"] = "RebuildGraph";
+    ETabletState["WriteZeroEntry"] = "WriteZeroEntry";
+    ETabletState["Restored"] = "Restored";
+    ETabletState["Discover"] = "Discover";
+    ETabletState["Lock"] = "Lock";
+    ETabletState["Dead"] = "Dead";
+    ETabletState["Active"] = "Active";
+    ETabletState["ResolveLeader"] = "ResolveLeader";
+    ETabletState["Deleted"] = "Deleted";
+    ETabletState["Stopped"] = "Stopped";
+})(ETabletState || (ETabletState = {}));

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

@@ -0,0 +1,147 @@
+import { EFlag } from './enums';
+import { TPoolStats, TSystemStateInfo } from './nodes';
+import { TTabletStateInfo } from './tablet';
+/**
+ * endpoint: /viewer/json/tenants
+ *
+ * source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
+ */
+export interface TTenants {
+    Tenants?: TTenant[];
+}
+/**
+ * endpoint: /viewer/json/tenantinfo
+ *
+ * source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
+ */
+export interface TTenantInfo {
+    TenantInfo?: TTenant[];
+    Errors?: string[];
+}
+export interface TTenant {
+    Name?: string;
+    Id?: string;
+    Type?: ETenantType;
+    State?: State;
+    StateStats?: THiveDomainStatsStateCount[];
+    Metrics?: TMetrics;
+    NodeIds?: number[];
+    AliveNodes?: number;
+    Resources?: TTenantResources;
+    /** uint64 */
+    CreateTime?: string;
+    Owner?: string;
+    Users?: string[];
+    PoolStats?: TPoolStats[];
+    UserAttributes?: Record<string, string>;
+    Overall?: EFlag;
+    SystemTablets?: TTabletStateInfo[];
+    ResourceId?: string;
+    Tablets?: TTabletStateInfo[];
+    /** uint64 */
+    StorageAllocatedSize?: string;
+    /** uint64 */
+    StorageMinAvailableSize?: string;
+    Nodes?: TSystemStateInfo[];
+    /** uint64 */
+    MemoryUsed?: string;
+    /** uint64 */
+    MemoryLimit?: string;
+    /** double */
+    CoresUsed?: number;
+    /** uint64 */
+    StorageGroups?: string;
+    MonitoringEndpoint?: string;
+    ControlPlane?: ControlPlane;
+    StorageAllocatedLimit?: string;
+    DatabaseQuotas?: DatabaseQuotas;
+}
+export interface THiveDomainStatsStateCount {
+    VolatileState?: ETabletVolatileState;
+    Count?: number;
+}
+export interface TMetrics {
+    /** uint64 */
+    CPU?: string;
+    /** uint64 */
+    Memory?: string;
+    /** uint64 */
+    Network?: string;
+    /** uint64 */
+    Counter?: string;
+    /** uint64 */
+    Storage?: string;
+    /** uint64 */
+    ReadThroughput?: string;
+    /** uint64 */
+    WriteThroughput?: string;
+    /** uint64 */
+    ReadIops?: string;
+    /** uint64 */
+    WriteIops?: string;
+    GroupReadThroughput?: TThroughputRecord[];
+    GroupWriteThroughput?: TThroughputRecord[];
+    GroupReadIops?: TIopsRecord[];
+    GroupWriteIops?: TIopsRecord[];
+}
+interface TThroughputRecord {
+    GroupID?: number;
+    Channel?: number;
+    /** uint64 */
+    Throughput?: string;
+}
+interface TIopsRecord {
+    GroupID?: number;
+    Channel?: number;
+    /** uint64 */
+    Iops?: string;
+}
+export interface TTenantResources {
+    Required?: TTenantResource[];
+    Allocated?: TTenantResource[];
+}
+export interface TTenantResource {
+    Type: string;
+    Zone: string;
+    Kind: string;
+    Count: number;
+}
+/** incomplete */
+export interface ControlPlane {
+    name?: string;
+}
+export declare enum ETenantType {
+    'UnknownTenantType' = "UnknownTenantType",
+    'Domain' = "Domain",
+    'Dedicated' = "Dedicated",
+    'Shared' = "Shared",
+    'Serverless' = "Serverless"
+}
+export declare enum State {
+    'STATE_UNSPECIFIED' = "STATE_UNSPECIFIED",
+    'CREATING' = "CREATING",
+    'RUNNING' = "RUNNING",
+    'REMOVING' = "REMOVING",
+    'PENDING_RESOURCES' = "PENDING_RESOURCES",
+    'CONFIGURING' = "CONFIGURING"
+}
+export declare enum ETabletVolatileState {
+    'TABLET_VOLATILE_STATE_UNKNOWN' = "TABLET_VOLATILE_STATE_UNKNOWN",
+    'TABLET_VOLATILE_STATE_STOPPED' = "TABLET_VOLATILE_STATE_STOPPED",
+    'TABLET_VOLATILE_STATE_BOOTING' = "TABLET_VOLATILE_STATE_BOOTING",
+    'TABLET_VOLATILE_STATE_STARTING' = "TABLET_VOLATILE_STATE_STARTING",
+    'TABLET_VOLATILE_STATE_RUNNING' = "TABLET_VOLATILE_STATE_RUNNING"
+}
+export interface DatabaseQuotas {
+    /** uint64 */
+    data_size_hard_quota?: string;
+    /** uint64 */
+    data_size_soft_quota?: string;
+    /** uint64 */
+    data_stream_shards_quota?: string;
+    /** uint64 */
+    data_stream_reserved_storage_quota?: string;
+    /** uint32 */
+    ttl_min_run_internal_seconds?: string;
+}
+export {};

package/dist/types/api/tenant.js

@@ -0,0 +1,25 @@
+export var ETenantType;
+(function (ETenantType) {
+    ETenantType["UnknownTenantType"] = "UnknownTenantType";
+    ETenantType["Domain"] = "Domain";
+    ETenantType["Dedicated"] = "Dedicated";
+    ETenantType["Shared"] = "Shared";
+    ETenantType["Serverless"] = "Serverless";
+})(ETenantType || (ETenantType = {}));
+export var State;
+(function (State) {
+    State["STATE_UNSPECIFIED"] = "STATE_UNSPECIFIED";
+    State["CREATING"] = "CREATING";
+    State["RUNNING"] = "RUNNING";
+    State["REMOVING"] = "REMOVING";
+    State["PENDING_RESOURCES"] = "PENDING_RESOURCES";
+    State["CONFIGURING"] = "CONFIGURING";
+})(State || (State = {}));
+export var ETabletVolatileState;
+(function (ETabletVolatileState) {
+    ETabletVolatileState["TABLET_VOLATILE_STATE_UNKNOWN"] = "TABLET_VOLATILE_STATE_UNKNOWN";
+    ETabletVolatileState["TABLET_VOLATILE_STATE_STOPPED"] = "TABLET_VOLATILE_STATE_STOPPED";
+    ETabletVolatileState["TABLET_VOLATILE_STATE_BOOTING"] = "TABLET_VOLATILE_STATE_BOOTING";
+    ETabletVolatileState["TABLET_VOLATILE_STATE_STARTING"] = "TABLET_VOLATILE_STATE_STARTING";
+    ETabletVolatileState["TABLET_VOLATILE_STATE_RUNNING"] = "TABLET_VOLATILE_STATE_RUNNING";
+})(ETabletVolatileState || (ETabletVolatileState = {}));

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

@@ -0,0 +1,128 @@
+import { IProtobufTimeObject } from './common';
+import { Consumer, Entry, MultipleWindowsStat, PartitionStats, SupportedCodecs } from './consumer';
+/**
+ * endpoint: /json/describe_topic
+ *
+ * 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 DescribeTopicResult {
+    /** Description of scheme object. */
+    self?: Entry;
+    /** Settings for partitioning */
+    partitioning_settings?: PartitioningSettings;
+    /** Partitions description. */
+    partitions?: PartitionInfo[];
+    /**
+     * google.protobuf.Duration
+     *
+     * How long data in partition should be stored.
+     */
+    retention_period?: string | IProtobufTimeObject;
+    /**
+     * int64
+     *
+     * How much data in partition should be stored.
+     * Zero value means infinite limit.
+     */
+    retention_storage_mb?: string;
+    /**
+     * List of allowed codecs for writers.
+     * Writes with codec not from this list are forbidden.
+     */
+    supported_codecs?: SupportedCodecs;
+    /**
+     * int64
+     *
+     * Partition write speed in bytes per second.
+     * Zero value means default limit: 1 MB per second.
+     */
+    partition_write_speed_bytes_per_second?: string;
+    /**
+     * int64
+     *
+     * Burst size for write in partition, in bytes.
+     * Zero value means default limit: 1 MB.
+     */
+    partition_write_burst_bytes?: string;
+    /** User and server attributes of topic. Server attributes starts from "_" and will be validated by server. */
+    attributes?: Record<string, string>;
+    /** List of consumers for this topic. */
+    consumers?: Consumer[];
+    /** Metering settings. */
+    metering_mode?: MeteringMode;
+    /** Statistics of topic. */
+    topic_stats?: TopicStats;
+}
+/** 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;
+}
+export interface TopicStats {
+    /**
+     * int64
+     *
+     * Approximate size of topic.
+     */
+    store_size_bytes?: string;
+    /**
+     * google.protobuf.Timestamp
+     *
+     * Minimum of timestamps of last write among all partitions.
+     */
+    min_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 statistics. */
+    bytes_written?: MultipleWindowsStat;
+}
+/** Partitioning settings for topic. */
+interface PartitioningSettings {
+    /**
+     * int64
+     *
+     * Minimum partition count auto merge would stop working at.
+     *
+     * Zero value means default - 1.
+     */
+    min_active_partitions?: string;
+    /**
+     * int64
+     *
+     * Limit for total partition count, including active (open for write) and read-only partitions.
+     *
+     * Zero value means default - 100.
+     */
+    partition_count_limit?: string;
+}
+declare enum MeteringMode {
+    /** Use default */
+    METERING_MODE_UNSPECIFIED = "METERING_MODE_UNSPECIFIED",
+    /** Metering based on resource reservation */
+    METERING_MODE_RESERVED_CAPACITY = "METERING_MODE_RESERVED_CAPACITY",
+    /** Metering based on actual consumption. Default. */
+    METERING_MODE_REQUEST_UNITS = "METERING_MODE_REQUEST_UNITS"
+}
+export {};

package/dist/types/api/topic.js

@@ -0,0 +1,11 @@
+/* eslint-disable camelcase */
+var MeteringMode;
+(function (MeteringMode) {
+    /** Use default */
+    MeteringMode["METERING_MODE_UNSPECIFIED"] = "METERING_MODE_UNSPECIFIED";
+    /** Metering based on resource reservation */
+    MeteringMode["METERING_MODE_RESERVED_CAPACITY"] = "METERING_MODE_RESERVED_CAPACITY";
+    /** Metering based on actual consumption. Default. */
+    MeteringMode["METERING_MODE_REQUEST_UNITS"] = "METERING_MODE_REQUEST_UNITS";
+})(MeteringMode || (MeteringMode = {}));
+export {};