Merge branch 'next' into issue4245

novuhq · Oct 16, 2023 · cf4ebeb · cf4ebeb
2 parents 7a84d3e + 8b27f88
commit cf4ebeb
Show file tree

Hide file tree

Showing 356 changed files with 21,973 additions and 15,312 deletions.
diff --git a/.cspell.json b/.cspell.json
@@ -508,7 +508,12 @@
     "autodocs",
     "stackalt",
     "mediumdark",
-    "Docgen"
+    "Docgen",
+    "clicksend",
+    "Clicksend",
+    "Kamil",
+    "Myśliwiec",
+    "nestframework"
   ],
   "flagWords": [],
   "patterns": [

diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile
@@ -22,7 +22,7 @@ RUN . /etc/os-release \
 # RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}"
 
 # [Optional] Uncomment if you want to install more global node modules
-RUN su node -c "npm install -g pnpm@7.33.4"
+RUN su node -c "npm install -g pnpm@8.9.0"
 
 
 
diff --git a/.github/workflows/dev-deploy-api.yml b/.github/workflows/dev-deploy-api.yml
@@ -41,10 +41,6 @@ jobs:
     steps:
       - run: echo ${{ matrix.projectName }}
       - uses: actions/checkout@v3
-      - uses: ./.github/actions/checkout-submodules
-        with:
-          submodule_token: ${{ secrets.SUBMODULES_TOKEN }}
-          submodule_branch: "next"
       - uses: ./.github/actions/setup-project
       - uses: ./.github/actions/setup-redis-cluster
       - uses: mansagroup/nrwl-nx-action@v3
@@ -88,11 +84,6 @@ jobs:
         name: ['novu/api-ee', 'novu/api']
     steps:
       - uses: actions/checkout@v3
-      - uses: ./.github/actions/checkout-submodules
-        with:
-          enabled: ${{ contains (matrix.name,'ee') }}
-          submodule_token: ${{ secrets.SUBMODULES_TOKEN }}
-          submodule_branch: "next"
       - uses: ./.github/actions/setup-project
       - uses: ./.github/actions/docker/build-api
         id: docker_build

diff --git a/.github/workflows/dev-deploy-worker.yml b/.github/workflows/dev-deploy-worker.yml
@@ -50,11 +50,6 @@ jobs:
         name: ['novu/worker-ee', 'novu/worker']
     steps:
       - uses: actions/checkout@v3
-      - uses: ./.github/actions/checkout-submodules
-        with:
-          enabled: ${{ contains (matrix.name,'ee') }}
-          submodule_token: ${{ secrets.SUBMODULES_TOKEN }}
-          submodule_branch: "next"
       - uses: ./.github/actions/setup-project
       - uses: ./.github/actions/docker/build-worker
         id: docker_build

diff --git a/.github/workflows/prod-deploy-api.yml b/.github/workflows/prod-deploy-api.yml
@@ -30,10 +30,6 @@ jobs:
     steps:
       - run: echo ${{ matrix.projectName }}
       - uses: actions/checkout@v3
-      - uses: ./.github/actions/checkout-submodules
-        with:
-          submodule_token: ${{ secrets.SUBMODULES_TOKEN }}
-          submodule_branch: "next"
       - uses: ./.github/actions/setup-project
       - uses: ./.github/actions/setup-redis-cluster
       - uses: mansagroup/nrwl-nx-action@v3
@@ -79,11 +75,6 @@ jobs:
       id-token: write
     steps:
       - uses: actions/checkout@v3
-      - uses: ./.github/actions/checkout-submodules
-        with:
-          enabled: ${{ contains (matrix.name,'ee') }}
-          submodule_token: ${{ secrets.SUBMODULES_TOKEN }}
-          submodule_branch: "main"
       - uses: ./.github/actions/setup-project
 
       - name: build api

diff --git a/.github/workflows/prod-deploy-worker.yml b/.github/workflows/prod-deploy-worker.yml
@@ -38,11 +38,6 @@ jobs:
       id-token: write
     steps:
       - uses: actions/checkout@v3
-      - uses: ./.github/actions/checkout-submodules
-        with:
-          enabled: ${{ contains (matrix.name,'ee') }}
-          submodule_token: ${{ secrets.SUBMODULES_TOKEN }}
-          submodule_branch: "main"
       - uses: ./.github/actions/setup-project
 
       - name: build worker

diff --git a/.github/workflows/prod-deploy-ws.yml b/.github/workflows/prod-deploy-ws.yml
@@ -23,6 +23,8 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 80
     environment: Production
+    needs:
+      - test_ws
     strategy:
       matrix:
         name: [ 'novu/ws-ee', 'novu/ws' ]

diff --git a/.github/workflows/reusable-api-e2e.yml b/.github/workflows/reusable-api-e2e.yml
@@ -46,11 +46,6 @@ jobs:
           fi
       - uses: actions/checkout@v3
       # checkout with submodules if token is provided
-      - uses: ./.github/actions/checkout-submodules
-        with:
-          enabled: ${{ steps.setup.outputs.has_token == 'true' }}
-          submodule_token: ${{ secrets.SUBMODULES_TOKEN }}
-          submodule_branch: ${{ inputs.submodule_branch }}
       - uses: ./.github/actions/setup-project
       - uses: ./.github/actions/setup-redis-cluster
       - uses: mansagroup/nrwl-nx-action@v3
@@ -61,12 +56,16 @@ jobs:
       - uses: ./.github/actions/start-localstack
 
       - uses: ./.github/actions/run-worker
+        with:
+          launch_darkly_sdk_key: ${{ secrets.LAUNCH_DARKLY_SDK_KEY }}
 
         # Runs a single command using the runners shell
       - name: Build API
         run: CI='' pnpm build:api
 
       - name: Run E2E tests
+        env:
+          LAUNCH_DARKLY_SDK_KEY: ${{ secrets.LAUNCH_DARKLY_SDK_KEY }}
         run: |
           cd apps/api && pnpm test:e2e
 

diff --git a/.github/workflows/reusable-inbound-mail-e2e.yml b/.github/workflows/reusable-inbound-mail-e2e.yml
@@ -38,11 +38,6 @@ jobs:
     steps:
       # checkout with submodules if token is provided
       - uses: actions/checkout@v3
-      - uses: ./.github/actions/checkout-submodules
-        with:
-          enabled: ${{ steps.setup.outputs.has_token == 'true' }}
-          submodule_token: ${{ secrets.SUBMODULES_TOKEN }}
-          submodule_branch: ${{ inputs.submodule_branch }}
       - uses: ./.github/actions/setup-project
       - uses: ./.github/actions/setup-redis-cluster
       - uses: mansagroup/nrwl-nx-action@v3

diff --git a/.github/workflows/reusable-web-e2e.yml b/.github/workflows/reusable-web-e2e.yml
@@ -52,11 +52,6 @@ jobs:
 
       - uses: actions/checkout@v3
       # checkout with submodules if token is provided
-      - uses: ./.github/actions/checkout-submodules
-        with:
-          enabled: ${{ steps.setup.outputs.has_token == 'true' }}
-          submodule_token: ${{ secrets.SUBMODULES_TOKEN }}
-          submodule_branch: ${{ inputs.submodule_branch }}
       - uses: ./.github/actions/setup-project
         id: setup-project
         with:
@@ -105,7 +100,7 @@ jobs:
           echo "BROWSER_PATH=$(which chrome)" >> $GITHUB_ENV
 
       - name: Cypress run e2e
-        uses: cypress-io/github-action@v5
+        uses: cypress-io/github-action@v6
         env:
           NODE_ENV: test
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -116,7 +111,7 @@ jobs:
         with:
           working-directory: apps/web
           browser: "${{ env.BROWSER_PATH }}"
-          record: true
+          record: false
           parallel: false
           install: false
           config-file: cypress.config.ts
@@ -153,7 +148,7 @@ jobs:
         run: pnpm cypress install
 
       - name: Run Component tests 🧪
-        uses: cypress-io/github-action@v5
+        uses: cypress-io/github-action@v6
         env:
           NODE_ENV: test
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

diff --git a/.github/workflows/reusable-widget-e2e.yml b/.github/workflows/reusable-widget-e2e.yml
@@ -51,12 +51,6 @@ jobs:
           fi
       - uses: actions/checkout@v3
       # checkout with submodules if token is provided
-      - uses: ./.github/actions/checkout-submodules
-        with:
-          enabled: ${{ steps.setup.outputs.has_token == 'true' }}
-          submodule_token: ${{ secrets.SUBMODULES_TOKEN }}
-          submodule_branch: ${{ inputs.submodule_branch }}
-
       - uses: ./.github/actions/setup-project
         id: setup-project
         with:
@@ -101,7 +95,7 @@ jobs:
         run: pnpm cypress install
 
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v6
         env:
           NODE_ENV: test
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

diff --git a/.github/workflows/reusable-worker-e2e.yml b/.github/workflows/reusable-worker-e2e.yml
@@ -46,11 +46,7 @@ jobs:
         fi
     - uses: actions/checkout@v3
     # checkout with submodules if token is provided
-    - uses: ./.github/actions/checkout-submodules
-      with:
-        enabled: ${{ steps.setup.outputs.has_token == 'true' }}
-        submodule_token: ${{ secrets.SUBMODULES_TOKEN }}
-        submodule_branch: ${{ inputs.submodule_branch }}
+
     - uses: ./.github/actions/setup-project
 
     - uses: ./.github/actions/setup-redis-cluster

diff --git a/.github/workflows/reusable-ws-e2e.yml b/.github/workflows/reusable-ws-e2e.yml
@@ -44,12 +44,6 @@ jobs:
              echo "has_token=false" >> $GITHUB_OUTPUT
           fi
       - uses: actions/checkout@v3
-      # checkout with submodules if token is provided
-      - uses: ./.github/actions/checkout-submodules
-        with:
-          enabled: ${{ steps.setup.outputs.has_token == 'true' }}
-          submodule_token: ${{ secrets.SUBMODULES_TOKEN }}
-          submodule_branch: ${{ inputs.submodule_branch }}
       - uses: ./.github/actions/setup-project
       - uses: mansagroup/nrwl-nx-action@v3
         with:

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -241,7 +241,7 @@ jobs:
           else
             echo "::set-output name=has_token::false"
           fi
-  
+
   test_e2e_ee:
     name: Test E2E EE
     runs-on: ubuntu-latest
@@ -260,10 +260,6 @@ jobs:
     steps:
       - run: echo ${{ matrix.projectName }}
       - uses: actions/checkout@v3
-      - uses: ./.github/actions/checkout-submodules
-        with:
-          submodule_token: ${{ secrets.SUBMODULES_TOKEN }}
-          submodule_branch: "next"
       - uses: ./.github/actions/setup-project
       - uses: ./.github/actions/setup-redis-cluster
       - uses: mansagroup/nrwl-nx-action@v3

diff --git a/.gitpod.dockerfile b/.gitpod.dockerfile
@@ -1,4 +1,4 @@
 FROM gitpod/workspace-mongodb
 
 RUN sudo apt-get update  && sudo apt-get install -y redis-server  && sudo rm -rf /var/lib/apt/lists/*
-RUN npm install -g pnpm@7.33.4
+RUN npm install -g pnpm@8.9.0
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -20,7 +20,7 @@ You can open a new issue with this [issue form](https://github.com/novuhq/novu/i
 
 ### Requirements
 
-- Node.js version v14.19.3
+- Node.js version v16.15.1
 - MongoDB
 - Redis. To install Redis on your O.S, please follow the below guides
   - [To install Redis on Windows](https://redis.io/docs/getting-started/installation/install-redis-on-windows/)
@@ -33,8 +33,8 @@ You can open a new issue with this [issue form](https://github.com/novuhq/novu/i
 
 The project is a monorepo, meaning that it is a collection of multiple packages managed in the same repository.
 
-To learn more about the project structure visit [https://docs.novu.co/community/monorepo-structure](https://docs.novu.co/community/monorepo-structure).
 
+To learn more about the project structure and running the project locally, please have a look [here](https://docs.novu.co/community-support/introduction#run-novu-locally).
 After cloning your fork, you will need to run the `npm run setup:project` command to install and build all dependencies.
 
 To learn a detailed guide on running the project locally, checkout our guide on [how to run novu in local machine](https://docs.novu.co/community/run-in-local-machine).
@@ -53,7 +53,7 @@ To ensure consistency throughout the source code, please keep these rules in min
 
 ## Need help? Questions and suggestions
 
-Questions, suggestions, and thoughts are most welcome. Feel free to open a [GitHub Issue](https://github.com/novuhq/novu/issues/new/choose). We can also be reached in our [Discord Server](https://discord.novu.co).
+Questions, suggestions, and thoughts are most welcome. Feel free to open a [GitHub Issue](https://github.com/novuhq/novu/issues/new/choose). We can also be reached on our [Discord Server](https://discord.novu.co).
 
 ## Ways to contribute
 

diff --git a/README.md b/README.md
@@ -24,13 +24,15 @@ Interested in participating in Hacktoberfest? We extend a warm invitation! You a
 - Join our [Discord and engage with our community](https://discord.com/invite/novu), get answers to your challenges, stay updated on events, announcements & prizes.
 
 In addition to this repository, here are the other Novu repositories you can contribute to for Hacktoberfest:
-- [Novu docs](https://github.com/novuhq/docs/issues)
+- [Novu Docs](https://github.com/novuhq/docs/issues)
 - [Novu PHP SDK](https://github.com/novuhq/novu-php/issues)
 - [Novu Ruby SDK](https://github.com/novuhq/novu-ruby/issues)
 - [Novu Python SDK](https://github.com/novuhq/novu-python/issues)
 - [Novu Go SDK](https://github.com/novuhq/go-novu/issues)
 - [Novu Java SDK](https://github.com/novuhq/novu-java/issues)
 - [Novu Kotlin SDK](https://github.com/novuhq/novu-kotlin/issues)
+- [Novu Elixir SDK](https://github.com/novuhq/novu-elixir/issues)
+- [Novu Rust SDK](https://github.com/novuhq/novu-rust/issues)
 
 Your contribution, no matter its size, holds immense value. We eagerly await to see the impact you'll make in our community! 🚀
 
@@ -104,7 +106,11 @@ We are excited to launch the complete Novu API and admin panel. Want to give it
 npx novu init
 ```
 
-After setting up your account using the cloud or docker version you can trigger the API using the `@novu/node` package.
+After setting up your account using the cloud or docker version, you can trigger the API using the `@novu/node` package.
+
+For API documentation and reference, please visit [Novu API Reference](https://docs.novu.co/api-reference/events/trigger-event).
+
+To get started with the Node.js package, you can install it using npm:
 
 ```bash
 npm install @novu/node
@@ -202,10 +208,10 @@ Novu provides a single API to manage providers across multiple channels with a s
 
 #### 👇 Chat
 
-- [x] Slack
-- [x] Discord
-- [x] MS Teams
-- [x] Mattermost
+- [x] [Slack](https://github.com/novuhq/novu/tree/main/providers/slack)
+- [x] [Discord](https://github.com/novuhq/novu/tree/main/providers/discord)
+- [x] [MS Teams](https://github.com/novuhq/novu/tree/main/providers/ms-teams)
+- [x] [Mattermost](https://github.com/novuhq/novu/tree/main/providers/mattermost)
 
 #### 📱 In-App
 
@@ -222,7 +228,7 @@ Before you begin coding and collaborating, please read our [Code of Conduct](htt
 
 ## 💻 Need Help?
 
-We are more than happy to help you. If you are getting any errors or facing problems while working on this project, join our [Discord server](https://discord.novu.co) and ask for help. We are open to discussing anything related to the project.
+We are more than happy to help you. If you are getting any errors or facing problems while working on this project, join our [Discord server](https://discord.novu.co) and ask for help. We are open to discuss anything related to the project.
 
 ## ⚡ Immediate working space with Gitpod
 
@@ -232,7 +238,7 @@ We are more than happy to help you. If you are getting any errors or facing prob
 
 - [Home page](https://novu.co/)
 - [Contribution Guidelines](https://github.com/novuhq/novu/blob/main/CONTRIBUTING.md)
-- [Run Novu Locally](https://docs.novu.co/community/run-locally)
+- [Run Novu Locally](https://docs.novu.co/community/run-in-local-machine)
 
 ## 🛡️ License
 

diff --git a/_templates/provider/new/package.ejs.t b/_templates/provider/new/package.ejs.t
@@ -33,10 +33,6 @@
   "publishConfig": {
     "access": "public"
   },
-  "engines": {
-    "node": ">=13.0.0 <17.0.0",
-    "pnpm": "^7.26.0"
-  },
   "dependencies": {
     "@novu/stateless": "<%= version %>"
   },

diff --git a/apps/api/Dockerfile b/apps/api/Dockerfile
@@ -5,7 +5,7 @@ ENV BULL_MQ_PRO_NPM_TOKEN=$BULL_MQ_PRO_TOKEN
 ENV NX_DAEMON=false
 
 RUN npm i pm2 -g
-RUN npm --no-update-notifier --no-fund --global install pnpm@7.33.4
+RUN npm --no-update-notifier --no-fund --global install pnpm@8.9.0
 RUN pnpm --version
 
 WORKDIR /usr/src/app

diff --git a/apps/api/README.md b/apps/api/README.md
@@ -25,7 +25,7 @@
 
 ## Description
 
-[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
+[Nest](https://github.com/nestjs/nest) framework [TypeScript](https://www.typescriptlang.org/) starter repository.
 
 ## Installation
 

diff --git a/apps/api/e2e/compile-email-template.e2e.ts b/apps/api/e2e/compile-email-template.e2e.ts
@@ -169,8 +169,8 @@ describe('Compile E-mail Template', function () {
     expect(senderName).to.equal(senderNameTest);
   });
 
-  describe('Backwards compatability', function () {
-    it('should compile e-mail template for custom html without layouts attached for backwards compatability', async function () {
+  describe('Backwards compatibility', function () {
+    it('should compile e-mail template for custom html without layouts attached for backwards compatibility', async function () {
       const { html, subject } = await useCase.execute(
         CompileEmailTemplateCommand.create({
           organizationId: session.organization._id,