[HUMAN App] Added enums parsing (#2633)

* Added enums parsing

* Improved interceptor

* Removed comments

Author: 0xVoronov

packages/apps/human-app/server/src/common/config/spec/gateway-config-service.mock.ts

@@ -2,78 +2,78 @@ export const gatewayConfigServiceMock = {
   getConfig: jest.fn().mockReturnValue({
     url: 'https://example.com',
     endpoints: {
-      WORKER_SIGNUP: {
+      worker_signup: {
         endpoint: '/auth/signup',
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
       },
-      OPERATOR_SIGNUP: {
+      operator_signup: {
         endpoint: '/auth/web3/signup',
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
       },
-      WORKER_SIGNIN: {
+      worker_signin: {
         endpoint: '/auth/signin',
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
       },
-      WORKER_REGISTRATION: {
+      worker_registration: {
         endpoint: '/user/registration',
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
       },
-      EMAIL_VERIFICATION: {
+      email_verification: {
         endpoint: '/auth/email-verification',
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
       },
-      RESEND_EMAIL_VERIFICATION: {
+      resend_email_verification: {
         endpoint: '/auth/resend-email-verification',
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
       },
-      FORGOT_PASSWORD: {
+      forgot_password: {
         endpoint: '/auth/forgot-password',
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
       },
-      RESTORE_PASSWORD: {
+      restore_password: {
         endpoint: '/auth/restore-password',
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
       },
-      PREPARE_SIGNATURE: {
+      prepare_signature: {
         endpoint: '/user/prepare-signature',
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
       },
-      DISABLE_OPERATOR: {
+      disable_operator: {
         endpoint: '/user/disable-operator',
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
       },
-      KYC_PROCEDURE_START: {
+      kyc_procedure_start: {
         endpoint: '/kyc/start',
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
       },
-      ENABLE_LABELING: {
+      enable_labeling: {
         endpoint: '/labeler/register',
         method: 'POST',
         params: { api_key: 'mock-api-key' },
       },
-      OPERATOR_SIGNIN: {
+      operator_signin: {
         endpoint: '/auth/web3/signin',
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
         params: {},
       },
-      REGISTER_ADDRESS: {
+      register_address: {
         endpoint: '/user/register-address',
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
       },
-      TOKEN_REFRESH: {
+      token_refresh: {
         endpoint: '/auth/refresh',
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },

packages/apps/human-app/server/src/common/decorators/enums.ts

@@ -0,0 +1,52 @@
+import {
+  registerDecorator,
+  ValidationOptions,
+  ValidationArguments,
+} from 'class-validator';
+import 'reflect-metadata';
+
+export function IsEnumCaseInsensitive(
+  enumType: any,
+  validationOptions?: ValidationOptions,
+) {
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  return function (object: Object, propertyName: string) {
+    // Attach enum metadata to the property
+    Reflect.defineMetadata('custom:enum', enumType, object, propertyName);
+
+    // Register the validation logic using class-validator
+    registerDecorator({
+      name: 'isEnumWithMetadata',
+      target: object.constructor,
+      propertyName: propertyName,
+      options: validationOptions,
+      validator: {
+        validate(value: any, args: ValidationArguments) {
+          // Retrieve enum type from metadata
+          const enumType = Reflect.getMetadata(
+            'custom:enum',
+            args.object,
+            args.property,
+          );
+          if (!enumType) {
+            return false; // If no enum metadata is found, validation fails
+          }
+
+          // Validate value is part of the enum
+          const enumValues = Object.values(enumType);
+          return enumValues.includes(value);
+        },
+        defaultMessage(args: ValidationArguments) {
+          // Default message if validation fails
+          const enumType = Reflect.getMetadata(
+            'custom:enum',
+            args.object,
+            args.property,
+          );
+          const enumValues = Object.values(enumType).join(', ');
+          return `${args.property} must be a valid enum value. Valid values: [${enumValues}]`;
+        },
+      },
+    });
+  };
+}

packages/apps/human-app/server/src/common/decorators/index.ts

@@ -0,0 +1 @@
+export * from './enums';

packages/apps/human-app/server/src/common/enums/external-api-name.ts

@@ -1,5 +1,5 @@
 export enum ExternalApiName {
-  REPUTATION_ORACLE = 'REPUTATION_ORACLE',
-  HCAPTCHA_LABELING_STATS = 'HCAPTCHA_LABELING_STATS',
-  HCAPTCHA_LABELING_VERIFY = 'HCAPTCHA_LABELING_VERIFY',
+  REPUTATION_ORACLE = 'reputation_oracle',
+  HCAPTCHA_LABELING_STATS = 'hcaptcha_labeling_stats',
+  HCAPTCHA_LABELING_VERIFY = 'hcaptcha_labeling_verify',
 }

packages/apps/human-app/server/src/common/enums/global-common.ts

@@ -5,29 +5,34 @@ export enum JobDiscoveryFieldName {
   CreatedAt = 'created_at',
   Qualifications = 'qualifications',
 }
+
 export enum JobStatus {
-  ACTIVE = 'ACTIVE',
-  COMPLETED = 'COMPLETED',
-  CANCELED = 'CANCELED',
+  ACTIVE = 'active',
+  COMPLETED = 'completed',
+  CANCELED = 'canceled',
 }
+
 export enum AssignmentStatus {
-  ACTIVE = 'ACTIVE',
-  VALIDATION = 'VALIDATION',
-  COMPLETED = 'COMPLETED',
-  EXPIRED = 'EXPIRED',
-  CANCELED = 'CANCELED',
-  REJECTED = 'REJECTED',
+  ACTIVE = 'active',
+  VALIDATION = 'validation',
+  COMPLETED = 'completed',
+  EXPIRED = 'expired',
+  CANCELED = 'canceled',
+  REJECTED = 'rejected',
 }
+
 export enum JobDiscoverySortField {
   CHAIN_ID = 'chain_id',
   JOB_TYPE = 'job_type',
   REWARD_AMOUNT = 'reward_amount',
   CREATED_AT = 'created_at',
 }
+
 export enum SortOrder {
-  ASC = 'ASC',
-  DESC = 'DESC',
+  ASC = 'asc',
+  DESC = 'desc',
 }
+
 export enum AssignmentSortField {
   CHAIN_ID = 'chain_id',
   JOB_TYPE = 'job_type',
@@ -36,10 +41,11 @@ export enum AssignmentSortField {
   CREATED_AT = 'created_at',
   EXPIRES_AT = 'expires_at',
 }
+
 export enum SignatureType {
-  SIGNUP = 'SIGNUP',
-  SIGNIN = 'SIGNIN',
-  DISABLE_OPERATOR = 'DISABLE_OPERATOR',
-  CERTIFICATE_AUTHENTICATION = 'CERTIFICATE_AUTHENTICATION',
-  REGISTER_ADDRESS = 'REGISTER_ADDRESS',
+  SIGNUP = 'signup',
+  SIGNIN = 'signin',
+  DISABLE_OPERATOR = 'disable_operator',
+  CERTIFICATE_AUTHENTICATION = 'certificate_authentication',
+  REGISTER_ADDRESS = 'register_address',
 }

packages/apps/human-app/server/src/common/enums/reputation-oracle-endpoints.ts

@@ -1,25 +1,25 @@
 export enum ReputationOracleEndpoints {
-  WORKER_SIGNUP = 'WORKER_SIGNUP',
-  WORKER_SIGNIN = 'WORKER_SIGNIN',
-  WORKER_REGISTRATION = 'WORKER_REGISTRATION',
-  OPERATOR_SIGNUP = 'OPERATOR_SIGNUP',
-  OPERATOR_SIGNIN = 'OPERATOR_SIGNIN',
-  EMAIL_VERIFICATION = 'EMAIL_VERIFICATION',
-  RESEND_EMAIL_VERIFICATION = 'RESEND_EMAIL_VERIFICATION',
-  FORGOT_PASSWORD = 'FORGOT_PASSWORD',
-  RESTORE_PASSWORD = 'RESTORE_PASSWORD',
-  PREPARE_SIGNATURE = 'PREPARE_SIGNATURE',
-  DISABLE_OPERATOR = 'DISABLE_OPERATOR',
-  KYC_PROCEDURE_START = 'KYC_PROCEDURE_START',
-  ENABLE_LABELING = 'ENABLE_LABELING',
-  REGISTER_ADDRESS = 'REGISTER_ADDRESS',
-  TOKEN_REFRESH = 'TOKEN_REFRESH',
-  KYC_ON_CHAIN = 'KYC_ON_CHAIN',
+  WORKER_SIGNUP = 'worker_signup',
+  WORKER_SIGNIN = 'worker_signin',
+  WORKER_REGISTRATION = 'worker_registration',
+  OPERATOR_SIGNUP = 'operator_signup',
+  OPERATOR_SIGNIN = 'operator_signin',
+  EMAIL_VERIFICATION = 'email_verification',
+  RESEND_EMAIL_VERIFICATION = 'resend_email_verification',
+  FORGOT_PASSWORD = 'forgot_password',
+  RESTORE_PASSWORD = 'restore_password',
+  PREPARE_SIGNATURE = 'prepare_signature',
+  DISABLE_OPERATOR = 'disable_operator',
+  KYC_PROCEDURE_START = 'kyc_procedure_start',
+  ENABLE_LABELING = 'enable_labeling',
+  REGISTER_ADDRESS = 'register_address',
+  TOKEN_REFRESH = 'token_refresh',
+  KYC_ON_CHAIN = 'kyc_on_chain',
 }
 export enum HCaptchaLabelingStatsEndpoints {
-  USER_STATS = 'USER_STATS',
-  DAILY_HMT_SPENT = 'DAILY_HMT_SPENT',
+  USER_STATS = 'user_stats',
+  DAILY_HMT_SPENT = 'daily_hmt_spent',
 }
 export enum HCaptchaLabelingVerifyEndpoints {
-  TOKEN_VERIFY = 'TOKEN_VERIFY',
+  TOKEN_VERIFY = 'token_verify',
 }

packages/apps/human-app/server/src/common/enums/user.ts

@@ -1,4 +1,4 @@
 export enum UserType {
-  OPERATOR = 'OPERATOR',
-  WORKER = 'WORKER',
+  OPERATOR = 'operator',
+  WORKER = 'worker',
 }

packages/apps/human-app/server/src/common/interceptors/interceptor.module.ts

@@ -1,6 +1,8 @@
 import { Module, Global } from '@nestjs/common';
 import { AxiosRequestInterceptor } from './axios-request.interceptor';
 import { EnvironmentConfigService } from '../config/environment-config.service';
+import { TransformEnumInterceptor } from './transform-enum.interceptor';
+import { APP_INTERCEPTOR } from '@nestjs/core';
 
 @Global()
 @Module({
@@ -15,6 +17,10 @@ import { EnvironmentConfigService } from '../config/environment-config.service';
       },
       inject: [EnvironmentConfigService],
     },
+    {
+      provide: APP_INTERCEPTOR,
+      useClass: TransformEnumInterceptor,
+    },
   ],
   exports: [AxiosRequestInterceptor],
 })