Decouple ui/* from api/* via openapi types

.eslintrc.js

@@ -48,11 +48,6 @@ module.exports = {
             group: 'internal',
             position: 'after',
           },
-          {
-            pattern: 'apiSrc/**',
-            group: 'internal',
-            position: 'after',
-          },
         ],
         warnOnUnassignedImports: true,
         pathGroupsExcludedImportTypes: ['builtin'],

jest.config.cjs

@@ -54,6 +54,7 @@ module.exports = {
     '/node_modules/',
     '<rootDir>/redisinsight/api',
     '<rootDir>/redisinsight/ui/src/packages',
+    '<rootDir>/redisinsight/ui/src/api-client',
   ],
   resolver: '<rootDir>/jest-resolver.js',
   reporters: [

redisinsight/api/openapitools.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
+  "spaces": 2,
+  "generator-cli": {
+    "version": "7.14.0"
+  }
+}

redisinsight/api/package.json

@@ -21,6 +21,7 @@
     "format": "prettier --write \"src/**/*.ts\"",
     "minify:prod": "node ./esbuild.js --production",
     "minify:dev": "node ./esbuild.js --watch",
+    "generate-client": "openapi-generator-cli generate -i http://localhost:5540/api/docs-json -g typescript-axios -o ../ui/src/api-client",
     "lint": "eslint --ext .ts .",
     "start": "nest start",
     "start:dev": "cross-env NODE_ENV=development nest start --watch",
@@ -106,6 +107,7 @@
     "@nestjs/cli": "^11.0.6",
     "@nestjs/schematics": "^11.0.5",
     "@nestjs/testing": "^11.0.20",
+    "@openapitools/openapi-generator-cli": "^2.21.0",
     "@types/adm-zip": "^0.5.0",
     "@types/express": "^5.0.0",
     "@types/ioredis-mock": "^8",
@@ -172,7 +174,6 @@
     ],
     "moduleNameMapper": {
       "src/(.*)": "<rootDir>/$1",
-      "apiSrc/(.*)": "<rootDir>/$1",
       "tests/(.*)": "<rootDir>/__tests__/$1"
     },
     "reporters": [

redisinsight/api/package.tmp.json

@@ -51,7 +51,6 @@
     "testEnvironment": "node",
     "moduleNameMapper": {
       "src/(.*)": "<rootDir>/$1",
-      "apiSrc/(.*)": "<rootDir>/$1",
       "tests/(.*)": "<rootDir>/__tests__/$1"
     },
     "setupFilesAfterEnv": ["../test/jest.setup.ts"]

redisinsight/api/src/common/decorators/index.ts

@@ -10,3 +10,4 @@ export * from './is-bigger-than.decorator';
 export * from './is-github-link.decorator';
 export * from './database-management.decorator';
 export * from './no-duplicates.decorator';
+export * from './redis-string-schema.decorator';

redisinsight/api/src/common/decorators/redis-string-schema.decorator.ts

@@ -0,0 +1,32 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export const REDIS_STRING_SCHEMA = {
+  type: String,
+  oneOf: [
+    { type: 'string' },
+    {
+      type: 'object',
+      properties: {
+        type: { type: 'string', enum: ['Buffer'], example: 'Buffer' },
+        data: {
+          type: 'array',
+          items: { type: 'number' },
+          example: [61, 101, 49],
+        },
+      },
+      required: ['type', 'data'],
+    },
+  ],
+};
+
+export const ApiRedisString = (
+  description: string = undefined,
+  isArray = false,
+  required = true,
+) =>
+  ApiProperty({
+    description,
+    isArray,
+    required,
+    ...REDIS_STRING_SCHEMA,
+  });

redisinsight/api/src/modules/browser/hash/dto/delete.fields-from-hash.dto.ts

@@ -1,15 +1,14 @@
 import { KeyDto } from 'src/modules/browser/keys/dto';
-import { ApiProperty } from '@nestjs/swagger';
 import { ArrayNotEmpty, IsArray, IsDefined } from 'class-validator';
-import { IsRedisString, RedisStringType } from 'src/common/decorators';
+import {
+  ApiRedisString,
+  IsRedisString,
+  RedisStringType,
+} from 'src/common/decorators';
 import { RedisString } from 'src/common/constants';
 
 export class DeleteFieldsFromHashDto extends KeyDto {
-  @ApiProperty({
-    description: 'Hash fields',
-    type: String,
-    isArray: true,
-  })
+  @ApiRedisString('Hash fields', true)
   @IsDefined()
   @IsArray()
   @ArrayNotEmpty()

redisinsight/api/src/modules/browser/hash/dto/hash-field.dto.ts

@@ -1,23 +1,21 @@
-import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { ApiPropertyOptional } from '@nestjs/swagger';
 import { IsDefined, IsInt, IsOptional, Max, Min } from 'class-validator';
-import { IsRedisString, RedisStringType } from 'src/common/decorators';
+import {
+  ApiRedisString,
+  IsRedisString,
+  RedisStringType,
+} from 'src/common/decorators';
 import { RedisString } from 'src/common/constants';
 import { MAX_TTL_NUMBER } from 'src/constants';
 
 export class HashFieldDto {
-  @ApiProperty({
-    description: 'Field',
-    type: String,
-  })
+  @ApiRedisString('Field')
   @IsDefined()
   @IsRedisString()
   @RedisStringType()
   field: RedisString;
 
-  @ApiProperty({
-    description: 'Field',
-    type: String,
-  })
+  @ApiRedisString('Field')
   @IsDefined()
   @IsRedisString()
   @RedisStringType()

redisinsight/api/src/modules/browser/hash/hash.controller.ts

@@ -41,6 +41,9 @@ export class HashController extends BrowserBaseController {
   @ApiOperation({ description: 'Set key to hold Hash data type' })
   @ApiRedisParams()
   @ApiBody({ type: CreateHashWithExpireDto })
+  @ApiOkResponse({
+    description: 'Hash key created successfully',
+  })
   @ApiQueryRedisStringEncoding()
   async createHash(
     @BrowserClientMetadata() clientMetadata: ClientMetadata,
@@ -75,6 +78,9 @@ export class HashController extends BrowserBaseController {
   })
   @ApiRedisParams()
   @ApiBody({ type: AddFieldsToHashDto })
+  @ApiOkResponse({
+    description: 'Fields added to hash successfully',
+  })
   @ApiQueryRedisStringEncoding()
   async addMember(
     @BrowserClientMetadata() clientMetadata: ClientMetadata,
@@ -89,6 +95,9 @@ export class HashController extends BrowserBaseController {
   })
   @ApiRedisParams()
   @ApiBody({ type: UpdateHashFieldsTtlDto })
+  @ApiOkResponse({
+    description: 'Hash fields TTL updated successfully',
+  })
   @ApiQueryRedisStringEncoding()
   async updateTtl(
     @BrowserClientMetadata() clientMetadata: ClientMetadata,
@@ -103,6 +112,10 @@ export class HashController extends BrowserBaseController {
   })
   @ApiRedisParams()
   @ApiBody({ type: DeleteFieldsFromHashDto })
+  @ApiOkResponse({
+    description: 'Fields removed from hash',
+    type: DeleteFieldsFromHashResponse,
+  })
   @ApiQueryRedisStringEncoding()
   async deleteFields(
     @BrowserClientMetadata() clientMetadata: ClientMetadata,

redisinsight/api/src/modules/browser/keys/dto/delete.keys.dto.ts

@@ -1,14 +1,13 @@
-import { ApiProperty } from '@nestjs/swagger';
 import { ArrayNotEmpty, IsArray, IsDefined } from 'class-validator';
-import { IsRedisString, RedisStringType } from 'src/common/decorators';
+import {
+  ApiRedisString,
+  IsRedisString,
+  RedisStringType,
+} from 'src/common/decorators';
 import { RedisString } from 'src/common/constants';
 
 export class DeleteKeysDto {
-  @ApiProperty({
-    description: 'Key name',
-    type: String,
-    isArray: true,
-  })
+  @ApiRedisString('Key name', true)
   @IsDefined()
   @IsArray()
   @ArrayNotEmpty()

redisinsight/api/src/modules/browser/keys/dto/get.keys-info.dto.ts

@@ -1,6 +1,10 @@
-import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { ApiPropertyOptional } from '@nestjs/swagger';
 import { IsDefined, IsEnum, IsOptional } from 'class-validator';
-import { IsRedisString, RedisStringType } from 'src/common/decorators';
+import {
+  ApiRedisString,
+  IsRedisString,
+  RedisStringType,
+} from 'src/common/decorators';
 import { RedisString } from 'src/common/constants';
 import { KeyDto, RedisDataType } from './key.dto';
 
@@ -16,12 +20,7 @@ export class GetKeyInfoDto extends KeyDto {
 }
 
 export class GetKeysInfoDto {
-  @ApiProperty({
-    description: 'List of keys',
-    type: String,
-    isArray: true,
-    example: ['keys', 'key2'],
-  })
+  @ApiRedisString('List of keys', true)
   @IsDefined()
   @IsRedisString({ each: true })
   @RedisStringType({ each: true })

redisinsight/api/src/modules/browser/keys/dto/get.keys-info.response.ts

@@ -1,11 +1,9 @@
 import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
-import { RedisStringType } from 'src/common/decorators';
+import { RedisStringType, ApiRedisString } from 'src/common/decorators';
 import { RedisString } from 'src/common/constants';
 
 export class GetKeyInfoResponse {
-  @ApiProperty({
-    type: String,
-  })
+  @ApiRedisString()
   @RedisStringType()
   name: RedisString;
 

redisinsight/api/src/modules/browser/keys/dto/key.dto.ts

@@ -1,6 +1,9 @@
-import { ApiProperty } from '@nestjs/swagger';
 import { IsDefined } from 'class-validator';
-import { IsRedisString, RedisStringType } from 'src/common/decorators';
+import {
+  ApiRedisString,
+  IsRedisString,
+  RedisStringType,
+} from 'src/common/decorators';
 import { RedisString } from 'src/common/constants';
 
 export enum RedisDataType {
@@ -16,10 +19,7 @@ export enum RedisDataType {
 }
 
 export class KeyDto {
-  @ApiProperty({
-    description: 'Key Name',
-    type: String,
-  })
+  @ApiRedisString('Key Name')
   @IsDefined()
   @IsRedisString()
   @RedisStringType()

redisinsight/api/src/modules/browser/keys/dto/rename.key.dto.ts

@@ -1,14 +1,14 @@
-import { ApiProperty } from '@nestjs/swagger';
 import { IsDefined } from 'class-validator';
-import { IsRedisString, RedisStringType } from 'src/common/decorators';
+import {
+  ApiRedisString,
+  IsRedisString,
+  RedisStringType,
+} from 'src/common/decorators';
 import { RedisString } from 'src/common/constants';
 import { KeyDto } from './key.dto';
 
 export class RenameKeyDto extends KeyDto {
-  @ApiProperty({
-    description: 'New key name',
-    type: String,
-  })
+  @ApiRedisString('New key name')
   @IsDefined()
   @IsRedisString()
   @RedisStringType()

redisinsight/api/src/modules/browser/keys/dto/rename.key.response.ts

@@ -1,13 +1,13 @@
-import { ApiProperty } from '@nestjs/swagger';
 import { IsDefined } from 'class-validator';
-import { IsRedisString, RedisStringType } from 'src/common/decorators';
+import {
+  ApiRedisString,
+  IsRedisString,
+  RedisStringType,
+} from 'src/common/decorators';
 import { RedisString } from 'src/common/constants';
 
 export class KeyResponse {
-  @ApiProperty({
-    description: 'Key Name',
-    type: String,
-  })
+  @ApiRedisString('keyName')
   @IsDefined()
   @IsRedisString()
   @RedisStringType()

redisinsight/api/src/modules/browser/keys/keys.controller.ts

@@ -44,6 +44,7 @@ export class KeysController {
   @ApiOkResponse({
     description: 'Keys list',
     type: GetKeysWithDetailsResponse,
+    isArray: true,
   })
   @ApiQueryRedisStringEncoding()
   async getKeys(
@@ -60,7 +61,8 @@ export class KeysController {
   @ApiRedisParams()
   @ApiOkResponse({
     description: 'Info for multiple keys',
-    type: GetKeysWithDetailsResponse,
+    type: GetKeyInfoResponse,
+    isArray: true,
   })
   @ApiQueryRedisStringEncoding()
   async getKeysInfo(

redisinsight/api/src/modules/browser/list/dto/delete.list-elements.response.ts

@@ -1,13 +1,8 @@
-import { ApiProperty } from '@nestjs/swagger';
-import { RedisStringType } from 'src/common/decorators';
+import { ApiRedisString, RedisStringType } from 'src/common/decorators';
 import { RedisString } from 'src/common/constants';
 
 export class DeleteListElementsResponse {
-  @ApiProperty({
-    type: String,
-    isArray: true,
-    description: 'Removed elements from list',
-  })
+  @ApiRedisString('Removed elements from list', true)
   @RedisStringType({ each: true })
   elements: RedisString[];
 }

redisinsight/api/src/modules/browser/list/dto/get.list-element.response.ts

@@ -1,13 +1,9 @@
 import { KeyResponse } from 'src/modules/browser/keys/dto';
-import { ApiProperty } from '@nestjs/swagger';
-import { RedisStringType } from 'src/common/decorators';
+import { ApiRedisString, RedisStringType } from 'src/common/decorators';
 import { RedisString } from 'src/common/constants';
 
 export class GetListElementResponse extends KeyResponse {
-  @ApiProperty({
-    type: () => String,
-    description: 'Element value',
-  })
+  @ApiRedisString('Element value')
   @RedisStringType()
   value: RedisString;
 }

redisinsight/api/src/modules/browser/list/dto/get.list-elements.response.ts

@@ -1,6 +1,6 @@
 import { KeyResponse } from 'src/modules/browser/keys/dto';
 import { ApiProperty } from '@nestjs/swagger';
-import { RedisStringType } from 'src/common/decorators';
+import { ApiRedisString, RedisStringType } from 'src/common/decorators';
 import { RedisString } from 'src/common/constants';
 
 export class GetListElementsResponse extends KeyResponse {
@@ -10,11 +10,7 @@ export class GetListElementsResponse extends KeyResponse {
   })
   total: number;
 
-  @ApiProperty({
-    type: () => String,
-    description: 'Array of elements.',
-    isArray: true,
-  })
+  @ApiRedisString('Elements', true)
   @RedisStringType({ each: true })
   elements: RedisString[];
 }