♻️ refactor(validations): centralize no allowed on demo validations

src/backend/entities/entities.controller.ts

@@ -1,5 +1,3 @@
-import { ILabelValue } from "shared/types/options";
-import { IEntityRelation } from "shared/types/db";
 import {
   ConfigurationApiService,
   configurationApiService,
@@ -12,14 +10,6 @@ export class EntitiesApiController {
     private _configurationApiService: ConfigurationApiService
   ) {}
 
-  async getActiveEntities(): Promise<ILabelValue[]> {
-    return await this._entitiesApiService.getActiveEntities();
-  }
-
-  async listAllEntities(): Promise<ILabelValue[]> {
-    return await this._entitiesApiService.getAllEntities();
-  }
-
   async listAllEntityRelations(entity: string): Promise<string[]> {
     const [entityRelations, disabledEntities] = await Promise.all([
       this._entitiesApiService.getEntityRelations(entity),
@@ -32,16 +22,6 @@ export class EntitiesApiController {
 
     return allowedEntityRelation.map(({ table }) => table);
   }
-
-  async getEntityRelations(
-    entity: string,
-    userRole: string
-  ): Promise<IEntityRelation[]> {
-    return await this._entitiesApiService.getEntityRelationsForUserRole(
-      entity,
-      userRole
-    );
-  }
 }
 
 export const entitiesApiController = new EntitiesApiController(

src/backend/lib/request/validations/implementations/index.ts

@@ -14,6 +14,7 @@ import { withPasswordValidationImpl as withPassword } from "./with-password";
 import { authenticatedUserValidationImpl as authenticatedUser } from "./authenticated-user";
 import { requestQueriesValidationImpl as requestQueries } from "./request-queries";
 import { rawRequestValidationImpl as rawRequest } from "./raw-request";
+import { notAllowedOnDemoValidationImpl as notAllowedOnDemo } from "./not-allowed-on-demo";
 
 import { ValidationImplType } from "./types";
 import { PortalValidationImpl } from "./portal";
@@ -31,6 +32,7 @@ export const ValidationImpl: Record<
   requestQuery,
   canUser,
   rawRequest,
+  notAllowedOnDemo,
   requestQueries,
   authenticatedUser,
   entity,

src/backend/lib/request/validations/implementations/not-allowed-on-demo.ts

@@ -0,0 +1,10 @@
+import { BadRequestError } from "backend/lib/errors";
+import { ValidationImplType } from "./types";
+
+export const notAllowedOnDemoValidationImpl: ValidationImplType<
+  void
+> = async () => {
+  if (process.env.NEXT_PUBLIC_IS_DEMO) {
+    throw new BadRequestError("This service is not available on the demo site");
+  }
+};

src/backend/lib/request/validations/types.ts

@@ -11,6 +11,7 @@ export type ValidationKeys = {
     | "rawRequest"
     | "paginationFilter"
     | "canUser"
+    | "notAllowedOnDemo"
     | "crudEnabled"
     | "requestBody"
     | "requestQuery"

src/backend/users/users.controller.ts

@@ -2,14 +2,8 @@ import { UnauthorizedError } from "backend/lib/errors";
 import { RolesApiService, rolesApiService } from "backend/roles/roles.service";
 import { REQUEST_ERROR_CODES } from "shared/constants/auth";
 import { ISignInForm } from "shared/form-schemas/auth/signin";
-import { IChangePasswordForm } from "shared/form-schemas/profile/password";
-import { IResetPasswordForm } from "shared/form-schemas/users/reset-password";
 import { ISuccessfullAuthenticationResponse } from "shared/types/auth/portal";
-import {
-  IAccountProfile,
-  IAccountUser,
-  IAuthenticatedUserBag,
-} from "shared/types/user";
+import { IAuthenticatedUserBag } from "shared/types/user";
 import { UsersApiService, usersApiService } from "./users.service";
 
 export class UsersApiController {
@@ -24,22 +18,6 @@ export class UsersApiController {
     return await this._usersService.tryAuthenticate(authCredentials);
   }
 
-  async listUsers() {
-    return await this._usersService.listUsers();
-  }
-
-  async createUser(user: IAccountUser) {
-    await this._usersService.registerUser(user);
-  }
-
-  async removeUser(username: string, myUsername: string) {
-    await this._usersService.removeUser(username, myUsername);
-  }
-
-  async getUserProfile(username: string) {
-    return await this._usersService.getUser(username);
-  }
-
   async getAuthenticatedUserBag(
     authenticatedUsername: string
   ): Promise<IAuthenticatedUserBag> {
@@ -62,18 +40,6 @@ export class UsersApiController {
       );
     }
   }
-
-  async resetPassword(username: string, input: IResetPasswordForm) {
-    await this._usersService.resetPassword(username, input.password);
-  }
-
-  async updatePassword(username: string, input: IChangePasswordForm) {
-    await this._usersService.changePassword(username, input);
-  }
-
-  async updateProfile(username: string, userDetails: IAccountProfile) {
-    await this._usersService.updateUser(username, userDetails);
-  }
 }
 
 export const usersApiController = new UsersApiController(

src/backend/users/users.service.ts

@@ -5,6 +5,7 @@ import { IApplicationService } from "backend/types";
 import { IAccountUser, IAccountProfile } from "shared/types/user";
 import { ISuccessfullAuthenticationResponse } from "shared/types/auth/portal";
 import { noop } from "shared/lib/noop";
+import { IResetPasswordForm } from "shared/form-schemas/users/reset-password";
 import { getPortalAuthenticationResponse } from "./portal";
 import { generateAuthTokenForUsername } from "./utils";
 import { usersPersistenceService } from "./shared";
@@ -101,10 +102,6 @@ export class UsersApiService implements IApplicationService {
       newPassword: string;
     }
   ) {
-    if (process.env.NEXT_PUBLIC_IS_DEMO) {
-      return;
-    }
-
     try {
       await this.checkUserPassword({
         username,
@@ -119,12 +116,9 @@ export class UsersApiService implements IApplicationService {
     });
   }
 
-  async resetPassword(username: string, newPassword: string) {
-    if (process.env.NEXT_PUBLIC_IS_DEMO) {
-      return;
-    }
+  async resetPassword(username: string, newPassword: IResetPasswordForm) {
     await this.updateUser(username, {
-      password: await HashService.make(newPassword),
+      password: await HashService.make(newPassword.password),
     });
   }
 

src/frontend/design-system/components/ListManager/index.tsx

@@ -64,7 +64,7 @@ export function ListManager<T, K extends StringProps<T>>({
   const onSortEnd = (oldOrder: number, newOrder: number) => {
     const newOrderItems = arrayMoveImmutable(itemsData, oldOrder, newOrder);
     setItemsData(newOrderItems);
-    sort?.on(newOrderItems.map((item) => item[sort.key] as string));
+    sort?.on(newOrderItems.map((item) => item[sort.key] as unknown as string));
   };
 
   useEffect(() => {

src/pages/api/account/[username]/index.ts

@@ -1,8 +1,8 @@
-import { usersApiController } from "backend/users/users.controller";
 import { USER_PERMISSIONS } from "shared/constants/user";
 import { UPDATE_USER_FORM_SCHEMA } from "shared/form-schemas/users/update";
 import { IAccountProfile } from "shared/types/user";
 import { requestHandler } from "backend/lib/request";
+import { usersApiService } from "backend/users/users.service";
 
 const REQUEST_QUERY_FIELD = "username";
 
@@ -15,9 +15,7 @@ export default requestHandler(
           options: REQUEST_QUERY_FIELD,
         },
       ]);
-      return await usersApiController.getUserProfile(
-        validatedRequest.requestQuery
-      );
+      return await usersApiService.getUser(validatedRequest.requestQuery);
     },
 
     DELETE: async (getValidatedRequest) => {
@@ -28,7 +26,7 @@ export default requestHandler(
           options: REQUEST_QUERY_FIELD,
         },
       ]);
-      return await usersApiController.removeUser(
+      return await usersApiService.removeUser(
         validatedRequest.requestQuery,
         (validatedRequest.authenticatedUser as IAccountProfile).username
       );
@@ -44,7 +42,7 @@ export default requestHandler(
           options: REQUEST_QUERY_FIELD,
         },
       ]);
-      return await usersApiController.updateProfile(
+      return await usersApiService.updateUser(
         validatedRequest.requestQuery,
         validatedRequest.requestBody
       );

src/pages/api/account/[username]/reset-password.ts

@@ -1,7 +1,7 @@
-import { usersApiController } from "backend/users/users.controller";
 import { RESET_PASSWORD_FORM_SCHEMA } from "shared/form-schemas/users/reset-password";
 import { USER_PERMISSIONS } from "shared/constants/user";
 import { requestHandler } from "backend/lib/request";
+import { usersApiService } from "backend/users/users.service";
 
 export default requestHandler(
   {
@@ -16,13 +16,16 @@ export default requestHandler(
           options: "username",
         },
       ]);
-      return await usersApiController.resetPassword(
+      return await usersApiService.resetPassword(
         validatedRequest.requestQuery,
         validatedRequest.requestBody
       );
     },
   },
   [
+    {
+      _type: "notAllowedOnDemo",
+    },
     {
       _type: "canUser",
       body: USER_PERMISSIONS.CAN_RESET_PASSWORD,

src/pages/api/account/change-password.ts

@@ -1,20 +1,27 @@
-import { usersApiController } from "backend/users/users.controller";
 import { CHANGE_PASSWORD_FORM_SCHEMA } from "shared/form-schemas/profile/password";
 import { IAccountProfile } from "shared/types/user";
 import { requestHandler } from "backend/lib/request";
+import { usersApiService } from "backend/users/users.service";
 
-export default requestHandler({
-  PATCH: async (getValidatedRequest) => {
-    const validatedRequest = await getValidatedRequest([
-      "authenticatedUser",
-      {
-        _type: "requestBody",
-        options: CHANGE_PASSWORD_FORM_SCHEMA,
-      },
-    ]);
-    return await usersApiController.updatePassword(
-      (validatedRequest.authenticatedUser as IAccountProfile).username,
-      validatedRequest.requestBody
-    );
+export default requestHandler(
+  {
+    PATCH: async (getValidatedRequest) => {
+      const validatedRequest = await getValidatedRequest([
+        "authenticatedUser",
+        {
+          _type: "requestBody",
+          options: CHANGE_PASSWORD_FORM_SCHEMA,
+        },
+      ]);
+      return await usersApiService.changePassword(
+        (validatedRequest.authenticatedUser as IAccountProfile).username,
+        validatedRequest.requestBody
+      );
+    },
   },
-});
+  [
+    {
+      _type: "notAllowedOnDemo",
+    },
+  ]
+);

src/pages/api/account/index.ts

@@ -1,11 +1,11 @@
-import { usersApiController } from "backend/users/users.controller";
 import { CREATE_USER_FORM_SCHEMA } from "shared/form-schemas/users/create";
 import { USER_PERMISSIONS } from "shared/constants/user";
 import { requestHandler } from "backend/lib/request";
+import { usersApiService } from "backend/users/users.service";
 
 export default requestHandler({
   GET: async () => {
-    return await usersApiController.listUsers();
+    return await usersApiService.listUsers();
   },
 
   POST: async (getValidatedRequest) => {
@@ -19,6 +19,6 @@ export default requestHandler({
         options: CREATE_USER_FORM_SCHEMA,
       },
     ]);
-    return await usersApiController.createUser(validatedRequest.requestBody);
+    return await usersApiService.registerUser(validatedRequest.requestBody);
   },
 });