feat(api-service): add internal sdk (#7599)

Author: tatarco

.cspell.json

@@ -6,9 +6,11 @@
     "ABNF",
     "ORGANISATION",
     "EQAs",
+    "analagous",
     "addrs",
     "subscriberpayloaddto",
     "adresses",
+    "APIJSON",
     "sdkerror",
     "idempotancy",
     "errordto",
@@ -800,6 +802,7 @@
     "apps/api/src/app/workflows-v2/maily-test-data.ts",
     "apps/api/src/app/workflows-v2/usecases/validate-content/validate-placeholders/validate-placeholder.usecase.ts",
     "apps/dashboard/eslint.config.js",
+    "libs/internal-sdk/**/*",
     "apps/web/env.sh",
     "apps/web/playwright.config.ts",
     "apps/web/src/pages/playground/web-container-configuration/sandbox-vite/*.ts",

.github/actions/run-api/action.yml

@@ -16,6 +16,7 @@ runs:
       with:
         targets: build
         projects: '@novu/api-service'
+        args: '--skip-nx-cache'
 
     - name: Start API
       shell: bash

.github/workflows/on-pr.yml

@@ -211,6 +211,7 @@ jobs:
         with:
           targets: lint,build,test
           projects: ${{matrix.projectName}}
+          args: '--skip-nx-cache'
 
   validate_openapi:
     name: Validate OpenAPI

.idea/swagger-settings.xml

@@ -1,6 +1,7 @@
 # package.json is formatted by package managers, so we ignore it here
 package.json
 apps/api/src/metadata.ts
+libs/internal-sdk
 
 /.nx/cache
 /.nx/workspace-data

.prettierignore

@@ -35,7 +35,9 @@ describe('Novu Node.js package - Retries and idempotency-key', () => {
       },
     ]);
     novuClient = new Novu({
-      apiKey: 'fakeKey',
+      security: {
+        secretKey: 'fakeKey',
+      },
       serverURL: BACKEND_URL,
       httpClient: mockHTTPClient,
     });
@@ -62,7 +64,9 @@ describe('Novu Node.js package - Retries and idempotency-key', () => {
       },
     ]);
     novuClient = new Novu({
-      apiKey: 'fakeKey',
+      security: {
+        secretKey: 'fakeKey',
+      },
       serverURL: BACKEND_URL,
       httpClient,
     });
@@ -93,7 +97,9 @@ describe('Novu Node.js package - Retries and idempotency-key', () => {
       },
     ]);
     novuClient = new Novu({
-      apiKey: 'fakeKey',
+      security: {
+        secretKey: 'fakeKey',
+      },
       serverURL: BACKEND_URL,
       httpClient: mockHTTPClient,
     });
@@ -106,7 +112,9 @@ describe('Novu Node.js package - Retries and idempotency-key', () => {
 
   it('should fail after reaching max retries', async () => {
     novuClient = new Novu({
-      apiKey: 'fakeKey',
+      security: {
+        secretKey: 'fakeKey',
+      },
       serverURL: BACKEND_URL,
       httpClient: new MockHTTPClient([
         {
@@ -161,7 +169,9 @@ describe('Novu Node.js package - Retries and idempotency-key', () => {
   NON_RECOVERABLE_ERRORS.forEach(([status, message]) => {
     it('should not retry on non-recoverable %i error', async () => {
       novuClient = new Novu({
-        apiKey: 'fakeKey',
+        security: {
+          secretKey: 'fakeKey',
+        },
         serverURL: BACKEND_URL,
         httpClient: new MockHTTPClient([
           {
@@ -234,7 +244,9 @@ describe('Novu Node.js package - Retries and idempotency-key', () => {
     ]);
 
     novuClient = new Novu({
-      apiKey: 'fakeKey',
+      security: {
+        secretKey: 'fakeKey',
+      },
       serverURL: BACKEND_URL,
       httpClient: mockClient,
     });

.source

@@ -1,7 +1,7 @@
 import { testServer } from '@novu/testing';
 import sinon from 'sinon';
 import chai from 'chai';
-import { connection, default as mongoose } from 'mongoose';
+import { default as mongoose } from 'mongoose';
 import { bootstrap } from '../src/bootstrap';
 
 async function dropDatabase() {
@@ -21,7 +21,7 @@ before(async () => {
    */
   chai.config.truncateThreshold = 0;
   await dropDatabase();
-  await testServer.create(await bootstrap());
+  await testServer.create((await bootstrap()).app);
 });
 
 after(async () => {

apps/api/e2e/retry.e2e.ts

@@ -0,0 +1,23 @@
+import { writeFileSync } from 'fs';
+import { bootstrap } from './src/bootstrap'; // Adjust the path according to your project structure
+
+async function exportOpenAPIJSON() {
+  try {
+    const { app, document } = await bootstrap();
+
+    // Write the Swagger document to a file
+    writeFileSync('./dist/swagger-spec.json', JSON.stringify(document, null, 2));
+    console.log('Swagger document generated at swagger-spec.json');
+
+    // Close the application
+    await app.close();
+    console.log('App Closed');
+  } catch (error) {
+    console.error('Error generating Swagger document:', error);
+  } finally {
+    // Ensure the process exits
+    process.exit();
+  }
+}
+
+exportOpenAPIJSON();

apps/api/e2e/setup.ts

@@ -8,6 +8,7 @@
   "scripts": {
     "prebuild": "rimraf dist",
     "build": "pnpm build:metadata && nest build",
+    "build:generate": "pnpm build:metadata && nest build && pnpm generate:swagger && pnpm generate:sdk",
     "build:watch": "pnpm build:metadata && nest build --watch",
     "format": "prettier --write \"src/**/*.ts\"",
     "docker:build": "pnpm --silent --workspace-root pnpm-context -- apps/api/Dockerfile | BULL_MQ_PRO_NPM_TOKEN=${BULL_MQ_PRO_NPM_TOKEN} docker buildx build --load -t novu-api --secret id=BULL_MQ_PRO_NPM_TOKEN --build-arg PACKAGE_PATH=apps/api - $DOCKER_BUILD_ARGUMENTS",
@@ -22,6 +23,8 @@
     "lint:fix": "pnpm lint -- --fix",
     "lint:openapi": "spectral lint http://127.0.0.1:${PORT:-3000}/openapi.yaml",
     "pretest": "pnpm build:metadata",
+    "generate:swagger": "cross-env NODE_ENV=test PORT=1336  ts-node exportOpenAPIJSON.ts",
+    "generate:sdk": " (cd ../../libs/internal-sdk && speakeasy run --skip-compile --minimal --skip-versioning) && (cd ../../libs/internal-sdk && pnpm build) ",
     "test": "cross-env TS_NODE_COMPILER_OPTIONS='{\"strictNullChecks\": false}' NODE_ENV=test mocha --require ts-node/register --exit 'src/**/*.spec.ts'",
     "test:e2e:novu-v1": "cross-env TS_NODE_COMPILER_OPTIONS='{\"strictNullChecks\": false}' NODE_ENV=test mocha --grep '#novu-v1' --require ts-node/register --exit --file e2e/setup.ts src/**/*.e2e{,-ee}.ts",
     "test:e2e:novu-v2": "cross-env TS_NODE_COMPILER_OPTIONS='{\"strictNullChecks\": false}' NODE_ENV=test CI_EE_TEST=true CLERK_ENABLED=true NODE_OPTIONS=--max_old_space_size=8192 mocha --grep '#novu-v2' --require ts-node/register --exit --file e2e/setup.ts 'src/**/*.e2e{,-ee}.ts'",
@@ -44,7 +47,7 @@
     "@nestjs/swagger": "7.4.0",
     "@nestjs/terminus": "10.2.3",
     "@nestjs/throttler": "6.2.1",
-    "@novu/api": "0.1.0",
+    "@novu/api": "workspace:*",
     "@novu/application-generic": "workspace:*",
     "@novu/dal": "workspace:*",
     "@novu/framework": "workspace:*",

apps/api/exportOpenAPIJSON.ts

@@ -27,7 +27,7 @@ import { InvitesModule } from './app/invites/invites.module';
 import { ContentTemplatesModule } from './app/content-templates/content-templates.module';
 import { IntegrationModule } from './app/integrations/integrations.module';
 import { ChangeModule } from './app/change/change.module';
-import { SubscribersModule } from './app/subscribers/subscribers.module';
+import { SubscribersV1Module } from './app/subscribers/subscribersV1.module';
 import { FeedsModule } from './app/feeds/feeds.module';
 import { LayoutsModule } from './app/layouts/layouts.module';
 import { MessagesModule } from './app/messages/messages.module';
@@ -49,7 +49,7 @@ import { WorkflowModule } from './app/workflows-v2/workflow.module';
 import { WorkflowModuleV1 } from './app/workflows-v1/workflow-v1.module';
 import { EnvironmentsModuleV1 } from './app/environments-v1/environments-v1.module';
 import { EnvironmentsModule } from './app/environments-v2/environments.module';
-import { SubscriberModule } from './app/subscribers-v2/subscriber.module';
+import { SubscribersModule } from './app/subscribers-v2/subscribers.module';
 
 const enterpriseImports = (): Array<Type | DynamicModule | Promise<DynamicModule> | ForwardReference> => {
   const modules: Array<Type | DynamicModule | Promise<DynamicModule> | ForwardReference> = [];
@@ -97,8 +97,8 @@ const baseModules: Array<Type | DynamicModule | Promise<DynamicModule> | Forward
   UserModule,
   IntegrationModule,
   ChangeModule,
+  SubscribersV1Module,
   SubscribersModule,
-  SubscriberModule,
   FeedsModule,
   LayoutsModule,
   MessagesModule,

apps/api/package.json

@@ -5,7 +5,6 @@ import { IUserResetTokenCount, UserEntity, UserRepository } from '@novu/dal';
 import { buildUserKey, InvalidateCacheService } from '@novu/application-generic';
 
 import { normalizeEmail, PasswordResetFlowEnum } from '@novu/shared';
-import { Novu } from '@novu/api';
 import { PasswordResetRequestCommand } from './password-reset-request.command';
 
 @Injectable()
@@ -39,21 +38,7 @@ export class PasswordResetRequest {
       await this.userRepository.updatePasswordResetToken(foundUser._id, token, resetTokenCount);
 
       if ((process.env.NODE_ENV === 'dev' || process.env.NODE_ENV === 'production') && process.env.NOVU_API_KEY) {
-        const novu = new Novu({ apiKey: process.env.NOVU_API_KEY });
         const resetPasswordLink = PasswordResetRequest.getResetRedirectLink(token, foundUser, command.src);
-
-        await novu.trigger({
-          name: process.env.NOVU_TEMPLATEID_PASSWORD_RESET || 'password-reset-llS-wzWMq',
-          to: [
-            {
-              subscriberId: foundUser._id,
-              email: foundUser.email,
-            },
-          ],
-          payload: {
-            resetPasswordLink,
-          },
-        });
       }
     }
 

apps/api/src/app.module.ts

@@ -152,6 +152,7 @@ export class TriggerEventRequestDto {
       { type: 'string', description: 'Unique identifier of a subscriber in your systems' },
       { $ref: getSchemaPath(SubscriberPayloadDto) },
     ],
+    required: false,
   })
   @IsOptional()
   @ValidateIf((_, value) => typeof value !== 'string')
@@ -166,6 +167,7 @@ export class TriggerEventRequestDto {
       { type: 'string', description: 'Unique identifier of a tenant in your system' },
       { $ref: getSchemaPath(TenantPayloadDto) },
     ],
+    required: false,
   })
   @IsOptional()
   @ValidateIf((_, value) => typeof value !== 'string')

apps/api/src/app/auth/usecases/password-reset-request/password-reset-request.usecase.ts

@@ -13,14 +13,14 @@ import { USE_CASES } from './usecases';
 import { SharedModule } from '../shared/shared.module';
 import { WidgetsModule } from '../widgets/widgets.module';
 import { AuthModule } from '../auth/auth.module';
-import { SubscribersModule } from '../subscribers/subscribers.module';
 import { ContentTemplatesModule } from '../content-templates/content-templates.module';
 import { IntegrationModule } from '../integrations/integrations.module';
 import { ExecutionDetailsModule } from '../execution-details/execution-details.module';
 import { TopicsModule } from '../topics/topics.module';
 import { LayoutsModule } from '../layouts/layouts.module';
 import { TenantModule } from '../tenant/tenant.module';
 import { BridgeModule } from '../bridge';
+import { SubscribersV1Module } from '../subscribers/subscribersV1.module';
 
 const PROVIDERS = [GetNovuProviderCredentials, StorageHelperService, EventsDistributedLockService];
 
@@ -30,7 +30,7 @@ const PROVIDERS = [GetNovuProviderCredentials, StorageHelperService, EventsDistr
     TerminusModule,
     WidgetsModule,
     AuthModule,
-    SubscribersModule,
+    SubscribersV1Module,
     ContentTemplatesModule,
     IntegrationModule,
     ExecutionDetailsModule,

apps/api/src/app/events/dtos/trigger-event-request.dto.ts

@@ -2,13 +2,13 @@ import { Module } from '@nestjs/common';
 import { AuthModule } from '../auth/auth.module';
 import { IntegrationModule } from '../integrations/integrations.module';
 import { SharedModule } from '../shared/shared.module';
-import { SubscribersModule } from '../subscribers/subscribers.module';
+import { SubscribersV1Module } from '../subscribers/subscribersV1.module';
 import { InboxController } from './inbox.controller';
 import { USE_CASES } from './usecases';
 import { PreferencesModule } from '../preferences';
 
 @Module({
-  imports: [SharedModule, SubscribersModule, AuthModule, IntegrationModule, PreferencesModule],
+  imports: [SharedModule, SubscribersV1Module, AuthModule, IntegrationModule, PreferencesModule],
   providers: [...USE_CASES],
   exports: [...USE_CASES],
   controllers: [InboxController],

apps/api/src/app/events/events.module.ts

@@ -56,7 +56,7 @@ export class AcceptInvite {
 
     try {
       if ((process.env.NODE_ENV === 'dev' || process.env.NODE_ENV === 'production') && process.env.NOVU_API_KEY) {
-        const novu = new Novu({ apiKey: process.env.NOVU_API_KEY });
+        const novu = new Novu({ security: { secretKey: process.env.NOVU_API_KEY } });
 
         await novu.trigger({
           name: process.env.NOVU_TEMPLATEID_INVITE_ACCEPTED || 'invite-accepted-dEQAsKD1E',

apps/api/src/app/inbox/inbox.module.ts

@@ -33,7 +33,7 @@ export class InviteMember {
     const token = createGuid();
 
     if (process.env.NOVU_API_KEY && (process.env.NODE_ENV === 'dev' || process.env.NODE_ENV === 'production')) {
-      const novu = new Novu({ apiKey: process.env.NOVU_API_KEY });
+      const novu = new Novu({ security: { secretKey: process.env.NOVU_API_KEY } });
       await novu.trigger({
         name: process.env.NOVU_TEMPLATEID_INVITE_TO_ORGANISATION || 'invite-to-organization-wBnO8NpDn',
         to: [

apps/api/src/app/invites/usecases/accept-invite/accept-invite.usecase.ts

@@ -34,7 +34,7 @@ export class ResendInvite {
     const token = createGuid();
 
     if (process.env.NODE_ENV === 'dev' || process.env.NODE_ENV === 'production') {
-      const novu = new Novu({ apiKey: process.env.NOVU_API_KEY ?? '' });
+      const novu = new Novu({ security: { secretKey: process.env.NOVU_API_KEY } });
 
       // cspell:disable-next
       await novu.trigger({

apps/api/src/app/invites/usecases/invite-member/invite-member.usecase.ts

@@ -1,14 +1,14 @@
-import { Module, forwardRef } from '@nestjs/common';
+import { forwardRef, Module } from '@nestjs/common';
 import { TerminusModule } from '@nestjs/terminus';
 import { SharedModule } from '../shared/shared.module';
 import { USE_CASES } from './usecases';
 import { MessagesController } from './messages.controller';
 import { AuthModule } from '../auth/auth.module';
 import { WidgetsModule } from '../widgets/widgets.module';
-import { SubscribersModule } from '../subscribers/subscribers.module';
+import { SubscribersV1Module } from '../subscribers/subscribersV1.module';
 
 @Module({
-  imports: [SharedModule, SubscribersModule, AuthModule, TerminusModule, forwardRef(() => WidgetsModule)],
+  imports: [SharedModule, SubscribersV1Module, AuthModule, TerminusModule, forwardRef(() => WidgetsModule)],
   controllers: [MessagesController],
   providers: [...USE_CASES],
   exports: [...USE_CASES],

apps/api/src/app/invites/usecases/resend-invite/resend-invite.usecase.ts

@@ -2,7 +2,7 @@ import { IsHexColor, IsOptional, IsString, IsUrl } from 'class-validator';
 import { IsImageUrl } from '../../shared/validators/image.validator';
 
 const environments = ['production', 'test'];
-const protocols = environments.includes(process.env.NODE_ENV) ? ['https'] : ['http', 'https'];
+const protocols = environments.includes(process.env.NODE_ENV || '') ? ['https'] : ['http', 'https'];
 
 export class UpdateBrandingDetailsDto {
   @IsUrl({