feat(dal, shared, api): Add rate limit DAL attributes

apps/api/src/app/environments/usecases/create-environment/create-environment.e2e.ts

@@ -50,4 +50,14 @@ describe('Create Environment - /environments (POST)', async () => {
     expect(layouts.data[0].isDefault).to.equal(true);
     expect(layouts.data[0].content.length).to.be.greaterThan(20);
   });
+
+  it('should not set apiRateLimits field on environment by default', async function () {
+    const demoEnvironment = {
+      name: 'Hello App',
+    };
+    const { body } = await session.testAgent.post('/v1/environments').send(demoEnvironment).expect(201);
+    const dbEnvironment = await environmentRepository.findOne({ _id: body.data._id });
+
+    expect(dbEnvironment?.apiRateLimits).to.be.undefined;
+  });
 });

apps/api/src/app/organization/e2e/create-organization.e2e.ts

@@ -1,6 +1,6 @@
 import { MemberRepository, OrganizationRepository } from '@novu/dal';
 import { UserSession } from '@novu/testing';
-import { MemberRoleEnum } from '@novu/shared';
+import { ApiServiceLevelTypeEnum, MemberRoleEnum } from '@novu/shared';
 import { expect } from 'chai';
 
 describe('Create Organization - /organizations (POST)', async () => {
@@ -44,5 +44,16 @@ describe('Create Organization - /organizations (POST)', async () => {
     it('should not create organization with no name', async () => {
       await session.testAgent.post('/v1/organizations').send({}).expect(400);
     });
+
+    it('should create organization with apiServiceLevel of free by default', async () => {
+      const testOrganization = {
+        name: 'Free Org',
+      };
+
+      const { body } = await session.testAgent.post('/v1/organizations').send(testOrganization).expect(201);
+      const dbOrganization = await organizationRepository.findById(body.data._id);
+
+      expect(dbOrganization?.apiServiceLevel).to.eq(ApiServiceLevelTypeEnum.FREE);
+    });
   });
 });

apps/api/src/app/organization/usecases/create-organization/create-organization.usecase.ts

@@ -1,6 +1,6 @@
 import { Inject, Injectable, Scope } from '@nestjs/common';
 import { OrganizationEntity, OrganizationRepository, UserRepository } from '@novu/dal';
-import { MemberRoleEnum } from '@novu/shared';
+import { ApiServiceLevelTypeEnum, MemberRoleEnum } from '@novu/shared';
 import { AnalyticsService } from '@novu/application-generic';
 
 import { CreateEnvironmentCommand } from '../../../environments/usecases/create-environment/create-environment.command';
@@ -30,15 +30,14 @@ export class CreateOrganization {
   ) {}
 
   async execute(command: CreateOrganizationCommand): Promise<OrganizationEntity> {
-    const organization = new OrganizationEntity();
-
-    organization.logo = command.logo;
-    organization.name = command.name;
-
     const user = await this.userRepository.findById(command.userId);
     if (!user) throw new ApiException('User not found');
 
-    const createdOrganization = await this.organizationRepository.create(organization);
+    const createdOrganization = await this.organizationRepository.create({
+      logo: command.logo,
+      name: command.name,
+      apiServiceLevel: ApiServiceLevelTypeEnum.FREE,
+    });
 
     await this.addMemberUsecase.execute(
       AddMemberCommand.create({

libs/dal/src/repositories/environment/environment.entity.ts

@@ -2,6 +2,7 @@ import { Types } from 'mongoose';
 
 import type { OrganizationId } from '../organization';
 import type { ChangePropsValueType } from '../../types/helpers';
+import { IApiRateLimits } from '@novu/shared';
 
 export interface IApiKey {
   key: string;
@@ -28,6 +29,8 @@ export class EnvironmentEntity {
 
   apiKeys: IApiKey[];
 
+  apiRateLimits: IApiRateLimits;
+
   widget: IWidgetSettings;
 
   dns?: IDnsSettings;

libs/dal/src/repositories/environment/environment.schema.ts

@@ -1,5 +1,6 @@
 import * as mongoose from 'mongoose';
 import { Schema } from 'mongoose';
+import { IApiRateLimits, ApiRateLimitCategoryTypeEnum } from '@novu/shared';
 
 import { schemaOptions } from '../schema-default.options';
 import { EnvironmentDBModel } from './environment.entity';
@@ -28,6 +29,11 @@ const environmentSchema = new Schema<EnvironmentDBModel>(
         },
       },
     ],
+    apiRateLimits: {
+      [ApiRateLimitCategoryTypeEnum.TRIGGER]: Schema.Types.Number,
+      [ApiRateLimitCategoryTypeEnum.CONFIGURATION]: Schema.Types.Number,
+      [ApiRateLimitCategoryTypeEnum.GLOBAL]: Schema.Types.Number,
+    },
     widget: {
       notificationCenterEncryption: {
         type: Schema.Types.Boolean,

libs/dal/src/repositories/organization/organization.entity.ts

@@ -1,10 +1,14 @@
+import { ApiServiceLevelTypeEnum } from '@novu/shared';
+
 export class OrganizationEntity {
   _id: string;
 
   name: string;
 
   logo?: string;
 
+  apiServiceLevel?: ApiServiceLevelTypeEnum;
+
   branding: {
     fontFamily?: string;
     fontColor?: string;

libs/dal/src/repositories/organization/organization.schema.ts

@@ -1,5 +1,6 @@
 import * as mongoose from 'mongoose';
 import { Schema } from 'mongoose';
+import { ApiServiceLevelTypeEnum } from '@novu/shared';
 
 import { schemaOptions } from '../schema-default.options';
 import { OrganizationDBModel, PartnerTypeEnum } from './organization.entity';
@@ -8,6 +9,10 @@ const organizationSchema = new Schema<OrganizationDBModel>(
   {
     name: Schema.Types.String,
     logo: Schema.Types.String,
+    apiServiceLevel: {
+      type: Schema.Types.String,
+      enum: ApiServiceLevelTypeEnum,
+    },
     branding: {
       fontColor: Schema.Types.String,
       contentBackground: Schema.Types.String,

libs/shared/src/entities/environment/environment.interface.ts

@@ -1,3 +1,5 @@
+import { IApiRateLimits } from '../../types';
+
 export interface IEnvironment {
   _id?: string;
   name: string;
@@ -6,6 +8,7 @@ export interface IEnvironment {
   identifier: string;
   widget: IWidgetSettings;
   dns?: IDnsSettings;
+  apiRateLimits?: IApiRateLimits;
 
   branding?: {
     color: string;

libs/shared/src/entities/organization/organization.interface.ts

@@ -1,10 +1,12 @@
+import { ApiServiceLevelTypeEnum } from '../../types';
 import { IUserEntity } from '../user';
 import { MemberRoleEnum } from './member.enum';
 import { IMemberInvite, MemberStatusEnum } from './member.interface';
 
 export interface IOrganizationEntity {
   _id: string;
   name: string;
+  apiServiceLevel?: ApiServiceLevelTypeEnum;
   members: {
     _id: string;
     _userId?: string;

libs/shared/src/types/environment/index.ts

@@ -1 +1,9 @@
 export type EnvironmentId = string;
+
+export enum ApiRateLimitCategoryTypeEnum {
+  TRIGGER = 'trigger',
+  CONFIGURATION = 'configuration',
+  GLOBAL = 'global',
+}
+
+export type IApiRateLimits = Record<ApiRateLimitCategoryTypeEnum, number>;

libs/shared/src/types/organization/index.ts

@@ -1 +1,6 @@
 export type OrganizationId = string;
+
+export enum ApiServiceLevelTypeEnum {
+  FREE = 'free',
+  BUSINESS = 'business',
+}