feat(framework): add class-validator support #6945

paulwer · 2024-11-11T20:52:49Z

What changed? Why was the change needed?

Add Class Validator support for @novu/framework
Add type error messages when providing invalid schemas
Add Stringify<T> generic helper for helpful type error messages
Hard-code checkIsErrorResponse into @novu/framework to resolve ESM import issues from @novu/shared

Screenhots

Class validator peer dependency import failure message

 ⨯ Error: Tried to use a class-validator schema in @novu/framework without class-validator-jsonschema installed. Please install it by running `npm install class-validator-jsonschema`.
    at se (/Users/rifont/git/framework-next-turbo/.next/server/app/api/novu/route.js:411:77618)
    at async si.canHandle (/Users/rifont/git/framework-next-turbo/.next/server/app/api/novu/route.js:411:79403)
    at async sp (/Users/rifont/git/framework-next-turbo/.next/server/app/api/novu/route.js:411:81104)
    at async Object.discover (/Users/rifont/git/framework-next-turbo/.next/server/app/api/novu/route.js:505:10531)
    at async sl.addWorkflows (/Users/rifont/git/framework-next-turbo/.next/server/app/api/novu/route.js:501:8314)
    at async (/Users/rifont/git/framework-next-turbo/.next/server/app/api/novu/route.js:505:3508)
    at async te.do (/Users/rifont/git/framework-next-turbo/node_modules/.pnpm/next@15.0.3-canary.9_react-dom@19.0.0-rc-02c0e824-20241028_react@19.0.0-rc-02c0e824-20241028__utrvdij6okqvk6cvj3mqcl5cuy/node_modules/next/dist/compiled/next-server/app-route.runtime.prod.js:18:17826)
    at async te.handle (/Users/rifont/git/framework-next-turbo/node_modules/.pnpm/next@15.0.3-canary.9_react-dom@19.0.0-rc-02c0e824-20241028_react@19.0.0-rc-02c0e824-20241028__utrvdij6okqvk6cvj3mqcl5cuy/node_modules/next/dist/compiled/next-server/app-route.runtime.prod.js:18:22492)
    at async doRender (/Users/rifont/git/framework-next-turbo/node_modules/.pnpm/next@15.0.3-canary.9_react-dom@19.0.0-rc-02c0e824-20241028_react@19.0.0-rc-02c0e824-20241028__utrvdij6okqvk6cvj3mqcl5cuy/node_modules/next/dist/server/base-server.js:1455:42) {
  statusCode: 500,
  code: 'MissingDependencyError',
  data: [Array]
}

New type error messages shown when attempting to consume data for invalid schemas

Demonstrating a more advanced variant of the error message

Expand for optional sections

### Related enterprise PR

Special notes for your reviewer

closes #6682

reference #6840

Co-authored-by: Richard Fontein <32132657+rifont@users.noreply.github.com>

…validator-support' into feat-package-class-validator-support

….com/paulwer/novu into feat-package-class-validator-support

rifont · 2024-12-03T01:14:48Z

packages/framework/package.json

@@ -38,7 +38,7 @@
    "build:watch": "tsup --watch",
    "postbuild": "pnpm run check:exports && pnpm check:circulars",
    "check:exports": "attw --pack .",
-    "check:circulars": "madge --circular --extensions ts ./src",
+    "check:circulars": "madge --circular --extensions ts --exclude ../../shared ./src",


@SokratisVidros is seems that Framework is still detecting circular dependency issues from Framework, even though no issues are traced back to Framework (see logs below in collapsible). Note, shared does not report these issues using madge on it's own check:circulars script.

Furthermore it appears the PR removing shared circulars had a run pulled from local cache on CI, so this removal was never tested. I am reverting for now as it's a false-positive.

Details

1) ../../shared/dist/cjs/dto/index.d.ts > ../../shared/dist/cjs/dto/events/index.d.ts > ../../shared/dist/cjs/dto/events/event.interface.d.ts > ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/clerk/index.d.ts > ../../shared/dist/cjs/types/clerk/types.d.ts 2) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/clerk/index.d.ts > ../../shared/dist/cjs/types/clerk/types.d.ts > ../../shared/dist/cjs/entities/user/index.d.ts > ../../shared/dist/cjs/entities/user/user.interface.d.ts 3) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/handlebar-helpers/index.d.ts > ../../shared/dist/cjs/consts/handlebar-helpers/getTemplateVariables.d.ts 4) ../../shared/dist/cjs/dto/index.d.ts > ../../shared/dist/cjs/dto/events/index.d.ts > ../../shared/dist/cjs/dto/events/event.interface.d.ts > ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/entities/message-template/index.d.ts > ../../shared/dist/cjs/entities/message-template/message-template.interface.d.ts 5) ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/entities/message-template/index.d.ts > ../../shared/dist/cjs/entities/message-template/message-template.interface.d.ts 6) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/entities/message-template/index.d.ts > ../../shared/dist/cjs/entities/message-template/message-template.interface.d.ts 7) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/entities/step/index.d.ts 8) ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/entities/subscriber-preference/index.d.ts > ../../shared/dist/cjs/entities/subscriber-preference/subscriber-preference.interface.d.ts 9) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/entities/subscriber-preference/index.d.ts > ../../shared/dist/cjs/entities/subscriber-preference/subscriber-preference.interface.d.ts 10) ../../shared/dist/cjs/clients/index.d.ts > ../../shared/dist/cjs/clients/workflows-client.d.ts > ../../shared/dist/cjs/dto/index.d.ts > ../../shared/dist/cjs/dto/events/index.d.ts > ../../shared/dist/cjs/dto/events/event.interface.d.ts > ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/index.d.ts 11) ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/index.d.ts 12) ../../shared/dist/cjs/dto/index.d.ts > ../../shared/dist/cjs/dto/events/index.d.ts > ../../shared/dist/cjs/dto/events/event.interface.d.ts > ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/index.d.ts 13) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/index.d.ts > ../../shared/dist/cjs/entities/environment/index.d.ts > ../../shared/dist/cjs/entities/environment/environment.interface.d.ts 14) ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/index.d.ts > ../../shared/dist/cjs/entities/job/index.d.ts > ../../shared/dist/cjs/entities/job/job.interface.d.ts 15) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/index.d.ts > ../../shared/dist/cjs/entities/job/index.d.ts > ../../shared/dist/cjs/entities/job/job.interface.d.ts 16) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/index.d.ts > ../../shared/dist/cjs/entities/layout/index.d.ts > ../../shared/dist/cjs/entities/layout/layout.interface.d.ts 17) ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/index.d.ts 18) ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/index.d.ts 19) ../../shared/dist/cjs/dto/index.d.ts > ../../shared/dist/cjs/dto/events/index.d.ts > ../../shared/dist/cjs/dto/events/event.interface.d.ts > ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/index.d.ts > ../../shared/dist/cjs/entities/organization/index.d.ts > ../../shared/dist/cjs/entities/organization/organization.interface.d.ts 20) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/index.d.ts > ../../shared/dist/cjs/entities/organization/index.d.ts > ../../shared/dist/cjs/entities/organization/organization.interface.d.ts 21) ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/index.d.ts > ../../shared/dist/cjs/entities/subscriber/index.d.ts > ../../shared/dist/cjs/entities/subscriber/subscriber.interface.d.ts 22) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/index.d.ts > ../../shared/dist/cjs/entities/subscriber/index.d.ts > ../../shared/dist/cjs/entities/subscriber/subscriber.interface.d.ts 23) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/index.d.ts > ../../shared/dist/cjs/entities/tenant/index.d.ts > ../../shared/dist/cjs/entities/tenant/tenant.interface.d.ts 24) ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/index.d.ts > ../../shared/dist/cjs/entities/workflow-override/index.d.ts > ../../shared/dist/cjs/entities/workflow-override/workflow-override.interface.d.ts 25) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/index.d.ts > ../../shared/dist/cjs/entities/workflow-override/index.d.ts > ../../shared/dist/cjs/entities/workflow-override/workflow-override.interface.d.ts 26) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/index.d.ts 27) ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/index.d.ts > ../../shared/dist/cjs/utils/index.d.ts > ../../shared/dist/cjs/utils/bridge.utils.d.ts 28) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/index.d.ts > ../../shared/dist/cjs/utils/index.d.ts > ../../shared/dist/cjs/utils/bridge.utils.d.ts 29) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/index.d.ts > ../../shared/dist/cjs/utils/index.d.ts > ../../shared/dist/cjs/utils/buildWorkflowPreferences.d.ts 30) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts > ../../shared/dist/cjs/index.d.ts > ../../shared/dist/cjs/utils/index.d.ts > ../../shared/dist/cjs/utils/checkIsResponseError.d.ts 31) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts > ../../shared/dist/cjs/entities/notification-template/index.d.ts > ../../shared/dist/cjs/entities/notification-template/notification-template.interface.d.ts 32) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/index.d.ts > ../../shared/dist/cjs/consts/notification-item-buttons/notificationItemButton.d.ts > ../../shared/dist/cjs/entities/messages/index.d.ts > ../../shared/dist/cjs/entities/messages/messages.interface.d.ts 33) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/preferences/index.d.ts > ../../shared/dist/cjs/consts/preferences/preferences.const.d.ts 34) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/productFeatureEnabledForServiceLevel.d.ts 35) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/providers/index.d.ts > ../../shared/dist/cjs/consts/providers/credentials/index.d.ts > ../../shared/dist/cjs/consts/providers/credentials/provider-credentials.d.ts > ../../shared/dist/cjs/consts/providers/provider.interface.d.ts 36) ../../shared/dist/cjs/types/index.d.ts > ../../shared/dist/cjs/types/subscriber/index.d.ts > ../../shared/dist/cjs/consts/index.d.ts > ../../shared/dist/cjs/consts/rate-limiting/index.d.ts > ../../shared/dist/cjs/consts/rate-limiting/apiRateLimits.d.ts 37) ../../shared/dist/cjs/dto/workflows/workflow-commons-fields.d.ts > ../../shared/dist/cjs/dto/workflows/workflow-response-dto.d.ts > ../../shared/dist/cjs/dto/workflows/create-workflow-dto.d.ts 38) ../../shared/dist/cjs/dto/workflows/update-workflow-dto.d.ts > ../../shared/dist/cjs/dto/workflows/workflow-commons-fields.d.ts > ../../shared/dist/cjs/dto/workflows/workflow-response-dto.d.ts 39) ../../shared/dist/cjs/dto/workflows/workflow-commons-fields.d.ts > ../../shared/dist/cjs/dto/workflows/workflow-response-dto.d.ts

rifont · 2024-12-03T01:17:15Z

packages/framework/src/utils/platform.utils.ts

+ */
+export const checkIsResponseError = (err: unknown): err is IResponseError => {
+  return !!err && typeof err === 'object' && 'error' in err && 'message' in err && 'statusCode' in err;
+};


@SokratisVidros I have duplicated this from @novu/shared to resolve the error reported here in Discord and elsewhere when using Framework in Remix & NextJS. Enums may be an issue but this could resolve it.

rifont

Awesome work @paulwer , thank you for your contribution!

paulwer and others added 30 commits November 4, 2024 14:17

feat: add class-validator support

369ffaf

Merge branch 'next' into feat-package-class-validator-support

19c03c2

Merge branch 'next' into feat-package-class-validator-support

a16f147

Merge branch 'next' into feat-package-class-validator-support

1016672

Update packages/framework/src/validators/class-validator.validator.ts

c2c0512

Co-authored-by: Richard Fontein <32132657+rifont@users.noreply.github.com>

fixes

f343a9d

Merge branch 'next' into feat-package-class-validator-support

b91fe48

workaround for classValidator defaultStorage

8662b2b

Update packages/framework/src/validators/class-validator.validator.ts

df9128e

Co-authored-by: Richard Fontein <32132657+rifont@users.noreply.github.com>

fixes

86bd4f9

Merge remote-tracking branch 'refs/remotes/origin/feat-package-class-…

5d2b8e9

…validator-support' into feat-package-class-validator-support

Merge branch 'next' into feat-package-class-validator-support

2b8f000

refactor(types): replace any with unknown in T_Controls

f74470a

Update packages/framework/src/validators/class-validator.validator.ts

e7f3ef8

refactor(validator): simplify metadata storage import

c5daec5

docs(validator): update TODO comment with @see link

255115c

test(validation): update tests for validation changes

68e5c9c

refactor(types): update class type inference logic

ecec05d

test: remove JSON stringify from test assertion

836bde3

docs(schema.types): update ClassType type description

f3decf0

refactor(class-validator): improve type checking logic

ed7c857

test(validator): extract class-validator fixtures

322d118

Merge branch 'next' into feat-package-class-validator-support

7fb6368

refactor: Remove IsOptional from name property

b432668

Merge branch 'feat-package-class-validator-support' of https://github…

11210c4

….com/paulwer/novu into feat-package-class-validator-support

refactor(schema): remove zod dependency from schemas

76de6fa

docs(import.types): clarify dependency import comment

3eb118a

refactor(validators): update type imports and schema names

8049177

refactor(types): update import to use 'type' keyword

0d0b31b

docs(zod): add comment for ZodSchema type

15b9ab4

rifont added 3 commits December 3, 2024 03:06

refactor(types): update test and stringify logic

52e7084

build: exclude shared from circular check

d14be75

Merge branch 'next' into feat-package-class-validator-support

44a390f

rifont temporarily deployed to Linting December 3, 2024 01:10 — with GitHub Actions Inactive

rifont had a problem deploying to Linting December 3, 2024 01:10 — with GitHub Actions Failure

rifont reviewed Dec 3, 2024

View reviewed changes

refactor(schema): update SchemaError message wording

53dad23

rifont had a problem deploying to Linting December 3, 2024 01:30 — with GitHub Actions Failure

rifont temporarily deployed to Linting December 3, 2024 01:30 — with GitHub Actions Inactive

rifont had a problem deploying to Linting December 3, 2024 01:30 — with GitHub Actions Failure

rifont approved these changes Dec 3, 2024

View reviewed changes

docs: Fix typos in schema inference comments

905f6a5

rifont had a problem deploying to Linting December 3, 2024 01:37 — with GitHub Actions Failure

rifont temporarily deployed to Linting December 3, 2024 01:37 — with GitHub Actions Inactive

style(validator): fix import extensions warnings

49cc45d

rifont temporarily deployed to Linting December 3, 2024 01:50 — with GitHub Actions Inactive

rifont had a problem deploying to Linting December 3, 2024 01:50 — with GitHub Actions Failure

rifont temporarily deployed to Linting December 3, 2024 01:50 — with GitHub Actions Inactive

rifont requested a review from SokratisVidros December 3, 2024 02:57

Merge branch 'next' into feat-package-class-validator-support

7beb058

rifont temporarily deployed to Linting December 4, 2024 21:19 — with GitHub Actions Inactive

rifont had a problem deploying to Linting December 4, 2024 21:19 — with GitHub Actions Failure

rifont temporarily deployed to Linting December 4, 2024 21:19 — with GitHub Actions Inactive

Merge branch 'next' into feat-package-class-validator-support

48a81af

rifont had a problem deploying to Linting December 6, 2024 18:58 — with GitHub Actions Failure

rifont temporarily deployed to Linting December 6, 2024 18:58 — with GitHub Actions Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(framework): add class-validator support #6945

feat(framework): add class-validator support #6945

paulwer commented Nov 11, 2024 •

edited by rifont

Loading

rifont Dec 3, 2024 •

edited

Loading

rifont Dec 3, 2024

rifont left a comment

feat(framework): add class-validator support #6945

Are you sure you want to change the base?

feat(framework): add class-validator support #6945

Conversation

paulwer commented Nov 11, 2024 • edited by rifont Loading

What changed? Why was the change needed?

Screenhots

Special notes for your reviewer

rifont Dec 3, 2024 • edited Loading

Choose a reason for hiding this comment

rifont Dec 3, 2024

Choose a reason for hiding this comment

rifont left a comment

Choose a reason for hiding this comment

paulwer commented Nov 11, 2024 •

edited by rifont

Loading

rifont Dec 3, 2024 •

edited

Loading