ydb-embedded-ui 4.0.0 → 4.1.0

package/dist/types/api/netInfo.ts

@@ -0,0 +1,48 @@
+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;
+}
+
+interface TNetNodePeerInfo {
+    NodeId: number;
+    PeerName: string;
+    Connected: boolean;
+    ConnectStatus: EFlag;
+    /** uint64 */
+    ChangeTime: string;
+    NodeType: ENodeType;
+    DataCenter: string;
+    Rack: string;
+    Host: string;
+    Port: number;
+}
+
+enum ENodeType {
+    UnknownNodeType,
+    Static,
+    Dynamic,
+}

package/dist/types/api/nodes.ts

@@ -3,9 +3,11 @@ 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
-
+/**
+ * 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[];

package/dist/types/api/pdisk.ts

@@ -1,7 +1,16 @@
 import {EFlag} from './enums';
 
-// endpoint: /viewer/json/pdiskinfo
-// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/node_whiteboard.proto
+/**
+ * endpoint: /viewer/json/pdiskinfo
+ *
+ * source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/node_whiteboard.proto
+ */
+export interface TEvPDiskStateResponse {
+    PDiskStateInfo?: TPDiskStateInfo[];
+    /** uint64 */
+    ResponseTime?: string;
+    ResponseDuration?: number;
+}
 
 export interface TPDiskStateInfo {
     PDiskId?: number;

package/dist/types/api/storage.ts

@@ -1,9 +1,11 @@
 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
-
+/**
+ * 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[];

package/dist/types/api/tenant.ts

@@ -2,13 +2,20 @@ import {EFlag} from './enums';
 import {TPoolStats, TSystemStateInfo} from './nodes';
 import {TTabletStateInfo} from './tablet';
 
-// endpoint: /viewer/json/tenantinfo
-// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
-
+/**
+ * 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[];
@@ -47,6 +54,9 @@ export interface TTenant {
     CoresUsed: number;
     /** uint64 */
     StorageGroups: string;
+
+    MonitoringEndpoint?: string; // additional
+    ControlPlane?: ControlPlane; // additional
 }
 
 interface THiveDomainStatsStateCount {
@@ -107,6 +117,11 @@ interface TTenantResource {
     Count: number;
 }
 
+/** incomplete */
+interface ControlPlane {
+    name?: string;
+}
+
 export enum ETenantType {
     'UnknownTenantType' = 'UnknownTenantType',
     'Domain' = 'Domain',

package/dist/types/api/vdisk.ts

@@ -1,8 +1,16 @@
 import {EFlag} from './enums';
 import {TPDiskStateInfo} from './pdisk';
 
-// endpoint: /viewer/json/vdiskinfo
-// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/node_whiteboard.proto
+/**
+ * endpoint: /viewer/json/vdiskinfo
+ *
+ * source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/node_whiteboard.proto
+ */
+export interface TEvVDiskStateResponse {
+    VDiskStateInfo?: TVDiskStateInfo[];
+    ResponseTime?: string;
+    ResponseDuration?: number;
+}
 
 export interface TVDiskStateInfo {
     VDiskId?: TVDiskID;

package/dist/types/api/whoami.ts

@@ -0,0 +1,19 @@
+/**
+ * endpoint: /viewer/json/whoami
+ *
+ * source: https://github.com/ydb-platform/ydb/blob/main/ydb/library/aclib/protos/aclib.proto
+ */
+export interface TUserToken {
+    UserSID?: string;
+    GroupSIDs?: TProtoHashTable;
+    OriginalUserToken?: string;
+    AuthType?: string;
+}
+
+interface TProtoHashTable {
+    Buckets?: TProtoHashBucket[];
+}
+
+interface TProtoHashBucket {
+    Values?: string[];
+}

package/dist/types/window.d.ts

@@ -37,4 +37,9 @@ interface Window {
     custom_backend?: string;
 
     __REDUX_DEVTOOLS_EXTENSION_COMPOSE__?: typeof import('redux').compose;
+
+    userSettings?: Record<string, string | undefined>;
+    systemSettings?: Record<string, string | undefined>;
+
+    api: import('../services/api').YdbEmbeddedAPI;
 }

package/dist/utils/hooks/useTypedSelector.ts

@@ -1,5 +1,5 @@
 import {TypedUseSelectorHook, useSelector} from 'react-redux';
 
-import {IRootState} from '../../store';
+import {RootState} from '../../store';
 
-export const useTypedSelector: TypedUseSelectorHook<IRootState> = useSelector;
+export const useTypedSelector: TypedUseSelectorHook<RootState> = useSelector;

package/dist/utils/nodes.ts

@@ -15,6 +15,8 @@ export const NodesUptimeFilterTitles = {
 export const isUnavailableNode = (node: INodesPreparedEntity | TSystemStateInfo) =>
     !node.SystemState || node.SystemState === EFlag.Grey;
 
+export type NodeAddress = Pick<TSystemStateInfo, 'Host' | 'Endpoints'>;
+
 export interface AdditionalNodesInfo extends Record<string, unknown> {
-    getNodeRef?: Function;
+    getNodeRef?: (node?: NodeAddress) => string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ydb-embedded-ui",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "files": [
     "dist"
   ],

package/dist/services/api.d.ts

@@ -1,87 +0,0 @@
-type AxiosOptions = {
-    concurrentId?: string;
-};
-
-interface Window {
-    api: {
-        getSchema: (
-            params: {path: string},
-            axiosOptions?: AxiosOptions,
-        ) => Promise<import('../types/api/schema').TEvDescribeSchemeResult>;
-        getDescribe: (
-            params: {path: string},
-            axiosOptions?: AxiosOptions,
-        ) => Promise<import('../types/api/schema').TEvDescribeSchemeResult>;
-        getStorageInfo: (
-            params: {
-                tenant: string;
-                filter: string;
-                nodeId: string;
-            },
-            axiosOptions?: AxiosOptions,
-        ) => Promise<import('../types/api/storage').TStorageInfo>;
-        getNodes: (
-            params: import('../types/store/nodes').INodesApiRequestParams,
-            axiosOptions?: AxiosOptions,
-        ) => Promise<import('../types/api/nodes').TNodesInfo>;
-        getCompute: (path: string) => Promise<import('../types/api/compute').TComputeInfo>;
-        sendQuery: <
-            Action extends import('../types/api/query').Actions,
-            Schema extends import('../types/api/query').Schemas = undefined,
-        >(
-            params: {
-                query?: string;
-                database?: string;
-                action?: Action;
-                stats?: string;
-                schema?: Schema;
-            },
-            axiosOptions?: AxiosOptions,
-        ) => Promise<import('../types/api/query').QueryAPIResponse<Action, Schema>>;
-        getExplainQuery: <Action extends import('../types/api/query').ExplainActions = 'explain'>(
-            query: string,
-            database: string,
-            action?: Action,
-        ) => Promise<import('../types/api/query').ExplainResponse<Action>>;
-        getExplainQueryAst: (
-            query: string,
-            database: string,
-        ) => Promise<import('../types/api/query').ExplainResponse<'explain-ast'>>;
-        getHealthcheckInfo: (
-            database: string,
-        ) => Promise<import('../types/api/healthcheck').HealthCheckAPIResponse>;
-        getTenantInfo: (params: {
-            path: string;
-        }) => Promise<import('../types/api/tenant').TTenantInfo>;
-        getClusterInfo: () => Promise<import('../types/api/cluster').TClusterInfo>;
-        getTabletsInfo: (params: {
-            nodes?: string[];
-            path?: string;
-        }) => Promise<import('../types/api/tablet').TEvTabletStateResponse>;
-        getTabletDescribe: (
-            tenantId?: import('../types/api/tablet').TDomainKey,
-        ) => Promise<import('../types/api/schema').TEvDescribeSchemeResult>;
-        getTablet: (params: {
-            id?: string;
-        }) => Promise<import('../types/api/tablet').TEvTabletStateResponse>;
-        getTabletHistory: (params: {
-            id?: string;
-        }) => Promise<import('../types/api/tablet').UnmergedTEvTabletStateResponse>;
-        getHeatmapData: (params: {
-            path: string;
-        }) => Promise<import('../types/api/schema').TEvDescribeSchemeResult>;
-        getTopic: (params: {
-            path?: string;
-        }) => Promise<import('../types/api/topic').DescribeTopicResult>;
-        getConsumer: (params: {
-            path?: string;
-            consumer?: string;
-        }) => Promise<import('../types/api/consumer').DescribeConsumerResult>;
-        getHostInfo: () => Promise<import('../types/api/systemState').TEvSystemStateResponse>;
-        getNodeInfo: (
-            id?: string,
-        ) => Promise<import('../types/api/systemState').TEvSystemStateResponse>;
-        getNodesList: () => Promise<import('../types/api/nodesList').TEvNodesInfo>;
-        [method: string]: Function;
-    };
-}

package/dist/services/api.js

@@ -1,278 +0,0 @@
-import AxiosWrapper from '@gravity-ui/axios-wrapper';
-
-import {backend as BACKEND} from '../store';
-
-const config = {withCredentials: !window.custom_backend};
-
-const {settingsApi} = window.web_version ? window.systemSettings : {};
-
-export class YdbEmbeddedAPI extends AxiosWrapper {
-    getPath(path) {
-        return `${BACKEND}${path}`;
-    }
-    getClusterInfo() {
-        return this.get(this.getPath('/viewer/json/cluster'), {tablets: true});
-    }
-    getNodeInfo(id) {
-        return this.get(this.getPath('/viewer/json/sysinfo?enums=true'), {
-            node_id: id,
-        });
-    }
-    getTenants() {
-        return this.get(this.getPath('/viewer/json/tenantinfo'), {
-            tablets: 1,
-            storage: 1,
-        });
-    }
-    getTenantInfo({path}) {
-        return this.get(this.getPath('/viewer/json/tenantinfo'), {
-            path,
-            tablets: true,
-            storage: true,
-        });
-    }
-    getNodes({tenant, filter, storage, type = 'any', tablets = true}, {concurrentId} = {}) {
-        return this.get(
-            this.getPath('/viewer/json/nodes?enums=true'),
-            {
-                tenant,
-                with: filter,
-                storage,
-                type,
-                tablets,
-            },
-            {
-                concurrentId,
-            },
-        );
-    }
-    getCompute(path) {
-        return this.get(this.getPath('/viewer/json/compute?enums=true'), {path});
-    }
-    getStorageInfo({tenant, filter, nodeId}, {concurrentId} = {}) {
-        return this.get(
-            this.getPath(`/viewer/json/storage?enums=true`),
-            {
-                tenant,
-                node_id: nodeId,
-                with: filter,
-            },
-            {
-                concurrentId,
-            },
-        );
-    }
-    getPdiskInfo(nodeId, pdiskId) {
-        return this.get(this.getPath('/viewer/json/pdiskinfo?enums=true'), {
-            filter: `(NodeId=${nodeId}${pdiskId ? `;PDiskId=${pdiskId}` : ''})`,
-        });
-    }
-    getVdiskInfo({vdiskId, pdiskId, nodeId}) {
-        return this.get(this.getPath('/viewer/json/vdiskinfo?enums=true'), {
-            filter: `(VDiskId=${vdiskId ?? ''};PDiskId=${pdiskId ?? ''};NodeId=${nodeId ?? ''})`,
-        });
-    }
-    getGroupInfo(groupId) {
-        return this.get(this.getPath('/viewer/json/storage?enums=true'), {
-            group_id: groupId,
-        });
-    }
-    getHostInfo() {
-        return this.get(this.getPath('/viewer/json/sysinfo?node_id=.&enums=true'));
-    }
-    getTabletsInfo({nodes = [], path}) {
-        const filter = nodes.length > 0 && `(NodeId=[${nodes.join(',')}])`;
-        return this.get(this.getPath('/viewer/json/tabletinfo'), {
-            filter,
-            path,
-            enums: true,
-        });
-    }
-    getSchema({path}, {concurrentId} = {}) {
-        return this.get(
-            this.getPath('/viewer/json/describe'),
-            {
-                path,
-                enums: true,
-                backup: false,
-                private: true,
-                partition_config: true,
-                partition_stats: true,
-                partitioning_info: true,
-                subs: 1,
-            },
-            {concurrentId: concurrentId || `getSchema|${path}`},
-        );
-    }
-    getDescribe({path}, {concurrentId} = {}) {
-        return this.get(
-            this.getPath('/viewer/json/describe'),
-            {
-                path,
-                enums: true,
-                partition_stats: true,
-                subs: 0,
-            },
-            {concurrentId: concurrentId || `getDescribe|${path}`},
-        );
-    }
-    getSchemaAcl({path}) {
-        return this.get(
-            this.getPath('/viewer/json/acl'),
-            {
-                path,
-            },
-            {concurrentId: `getSchemaAcl|${path}`},
-        );
-    }
-    getHeatmapData({path}) {
-        return this.get(this.getPath('/viewer/json/describe'), {
-            path,
-            enums: true,
-            backup: false,
-            children: false,
-            partition_config: false,
-            partition_stats: true,
-        });
-    }
-    getNetwork(path) {
-        return this.get(this.getPath('/viewer/json/netinfo'), {
-            enums: true,
-            path,
-        });
-    }
-    getTopic({path}, {concurrentId} = {}) {
-        return this.get(
-            this.getPath('/viewer/json/describe_topic'),
-            {
-                enums: true,
-                include_stats: true,
-                path,
-            },
-            {concurrentId: concurrentId || 'getTopic'},
-        );
-    }
-    getConsumer({path, consumer}, {concurrentId} = {}) {
-        return this.get(
-            this.getPath('/viewer/json/describe_consumer'),
-            {
-                enums: true,
-                include_stats: true,
-                path,
-                consumer,
-            },
-            {concurrentId: concurrentId || 'getConsumer'},
-        );
-    }
-    getPoolInfo(poolName) {
-        return this.get(this.getPath('/viewer/json/storage'), {
-            pool: poolName,
-            enums: true,
-        });
-    }
-    getTablet({id}) {
-        return this.get(this.getPath(`/viewer/json/tabletinfo?filter=(TabletId=${id})`), {
-            enums: true,
-        });
-    }
-    getTabletHistory({id}) {
-        return this.get(this.getPath(`/viewer/json/tabletinfo?filter=(TabletId=${id})`), {
-            enums: true,
-            merge: false,
-        });
-    }
-    getNodesList() {
-        return this.get(this.getPath('/viewer/json/nodelist'), {enums: true});
-    }
-    getTenantsList() {
-        return this.get(this.getPath('/viewer/json/tenants'), {
-            enums: true,
-            state: 0,
-        });
-    }
-    sendQuery({query, database, action, stats, schema}, {concurrentId} = {}) {
-        return this.post(
-            this.getPath(`/viewer/json/query${schema ? `?schema=${schema}` : ''}`),
-            {
-                query,
-                database,
-                action,
-                stats,
-                timeout: 600000,
-            },
-            null,
-            {
-                concurrentId,
-                timeout: 9 * 60 * 1000,
-            },
-        );
-    }
-    getExplainQuery(query, database, action = 'explain') {
-        return this.post(this.getPath('/viewer/json/query'), {
-            query,
-            database,
-            action,
-            timeout: 600000,
-        });
-    }
-    getExplainQueryAst(query, database) {
-        return this.post(this.getPath('/viewer/json/query'), {
-            query,
-            database,
-            action: 'explain-ast',
-            timeout: 600000,
-        });
-    }
-    getHotKeys(path, enableSampling) {
-        return this.get(this.getPath('/viewer/json/hotkeys'), {
-            path,
-            enable_sampling: enableSampling,
-        });
-    }
-    getHealthcheckInfo(database) {
-        return this.get(this.getPath('/viewer/json/healthcheck'), {
-            tenant: database,
-        });
-    }
-    killTablet(id) {
-        return this.get(this.getPath(`/tablets?KillTabletID=${id}`));
-    }
-    stopTablet(id, hiveId) {
-        return this.get(
-            this.getPath(`/tablets/app?TabletID=${hiveId}&page=StopTablet&tablet=${id}`),
-        );
-    }
-    resumeTablet(id, hiveId) {
-        return this.get(
-            this.getPath(`/tablets/app?TabletID=${hiveId}&page=ResumeTablet&tablet=${id}`),
-        );
-    }
-    getTabletDescribe(tenantId) {
-        return this.get(this.getPath('/viewer/json/describe'), {
-            schemeshard_id: tenantId?.SchemeShard,
-            path_id: tenantId?.PathId,
-        });
-    }
-    postSetting(name, value) {
-        return this.request({
-            method: 'PATCH',
-            url: settingsApi,
-            data: {[name]: value},
-        });
-    }
-    authenticate(user, password) {
-        return this.post(this.getPath('/login'), {
-            user,
-            password,
-        });
-    }
-    logout() {
-        return this.post(this.getPath('/logout'), {});
-    }
-    whoami() {
-        return this.get(this.getPath('/viewer/json/whoami'));
-    }
-}
-
-const api = new YdbEmbeddedAPI({config: config});
-window.api = api;