feat: added PROSPECT role for freshly-created users

Author: marcinkrasowski

.changeset/rich-turkeys-refuse.md

@@ -0,0 +1,8 @@
+---
+'@o2s/integrations.strapi-cms': minor
+'@o2s/integrations.mocked': minor
+'@o2s/api-harmonization': minor
+'@o2s/framework': minor
+---
+
+added `PROSPECT` role for freshly-created users

apps/api-harmonization/src/blocks/user-account/user-account.controller.ts

@@ -16,7 +16,9 @@ export class UserAccountController {
     constructor(protected readonly service: UserAccountService) {}
 
     @Get()
-    @Auth.Decorators.Roles({ roles: [Auth.Constants.Roles.USER, Auth.Constants.Roles.ADMIN] })
+    @Auth.Decorators.Roles({
+        roles: [Auth.Constants.Roles.PROSPECT, Auth.Constants.Roles.USER, Auth.Constants.Roles.ADMIN],
+    })
     getUserAccountBlock(@Headers() headers: AppHeaders, @Query() query: GetUserAccountBlockQuery) {
         return this.service.getUserAccountBlock(query, headers).pipe(delay(500));
     }

package-lock.json

@@ -1,4 +1,5 @@
 export enum Roles {
+    PROSPECT = 'selfservice_prospect',
     USER = 'selfservice_user',
     ADMIN = 'selfservice_admin',
 }

packages/framework/src/modules/auth/auth.constants.ts

@@ -17,7 +17,7 @@ export const PAGE_DASHBOARD_PL: CMS.Model.Page.Page = {
             alt: 'Placeholder',
         },
     },
-    permissions: [Auth.Constants.Roles.USER, Auth.Constants.Roles.ADMIN],
+    permissions: [Auth.Constants.Roles.PROSPECT, Auth.Constants.Roles.USER, Auth.Constants.Roles.ADMIN],
     hasOwnTitle: false,
     template: {
         __typename: 'TwoColumnTemplate',
@@ -72,7 +72,7 @@ export const PAGE_DASHBOARD_EN: CMS.Model.Page.Page = {
             alt: 'Placeholder',
         },
     },
-    permissions: [Auth.Constants.Roles.USER, Auth.Constants.Roles.ADMIN],
+    permissions: [Auth.Constants.Roles.PROSPECT, Auth.Constants.Roles.USER, Auth.Constants.Roles.ADMIN],
     hasOwnTitle: false,
     template: {
         __typename: 'TwoColumnTemplate',
@@ -127,7 +127,7 @@ export const PAGE_DASHBOARD_DE: CMS.Model.Page.Page = {
             alt: 'Placeholder',
         },
     },
-    permissions: [Auth.Constants.Roles.USER, Auth.Constants.Roles.ADMIN],
+    permissions: [Auth.Constants.Roles.PROSPECT, Auth.Constants.Roles.USER, Auth.Constants.Roles.ADMIN],
     hasOwnTitle: false,
     template: {
         __typename: 'TwoColumnTemplate',

packages/integrations/mocked/src/modules/cms/mappers/mocks/pages/dashboard.page.ts

@@ -17,7 +17,7 @@ export const PAGE_USER_ACCOUNT_EN: CMS.Model.Page.Page = {
             alt: 'Placeholder',
         },
     },
-    permissions: [Auth.Constants.Roles.USER, Auth.Constants.Roles.ADMIN],
+    permissions: [Auth.Constants.Roles.PROSPECT, Auth.Constants.Roles.USER, Auth.Constants.Roles.ADMIN],
     hasOwnTitle: true,
     template: {
         __typename: 'OneColumnTemplate',
@@ -51,7 +51,7 @@ export const PAGE_USER_ACCOUNT_DE: CMS.Model.Page.Page = {
             alt: 'Placeholder',
         },
     },
-    permissions: [Auth.Constants.Roles.USER, Auth.Constants.Roles.ADMIN],
+    permissions: [Auth.Constants.Roles.PROSPECT, Auth.Constants.Roles.USER, Auth.Constants.Roles.ADMIN],
     hasOwnTitle: true,
     template: {
         __typename: 'OneColumnTemplate',
@@ -85,7 +85,7 @@ export const PAGE_USER_ACCOUNT_PL: CMS.Model.Page.Page = {
             alt: 'Placeholder',
         },
     },
-    permissions: [Auth.Constants.Roles.USER, Auth.Constants.Roles.ADMIN],
+    permissions: [Auth.Constants.Roles.PROSPECT, Auth.Constants.Roles.USER, Auth.Constants.Roles.ADMIN],
     hasOwnTitle: true,
     template: {
         __typename: 'OneColumnTemplate',

packages/integrations/mocked/src/modules/cms/mappers/mocks/pages/user-account.page.ts

@@ -7,6 +7,8 @@ export const mapRoles = (data?: RolesFragment): Auth.Constants.Roles[] => {
 
     return (data.roles as string[]).reduce<Auth.Constants.Roles[]>((prev, role) => {
         switch (role) {
+            case 'prospect':
+                return [...prev, Auth.Constants.Roles.PROSPECT];
             case 'user':
                 return [...prev, Auth.Constants.Roles.USER];
             case 'admin':