@novu/api 0.6.2 → 1.0.0

package/src/mcp-server/server.ts

@@ -11,7 +11,7 @@ import {
   createRegisterResource,
   createRegisterResourceTemplate,
 } from "./resources.js";
-import { MCPScope, mcpScopes } from "./scopes.js";
+import { MCPScope } from "./scopes.js";
 import { createRegisterTool } from "./tools.js";
 import { tool$cancel } from "./tools/cancel.js";
 import { tool$integrationsCreate } from "./tools/integrationsCreate.js";
@@ -48,15 +48,17 @@ import { tool$subscribersPreferencesUpdate } from "./tools/subscribersPreference
 import { tool$subscribersPropertiesUpdateOnlineFlag } from "./tools/subscribersPropertiesUpdateOnlineFlag.js";
 import { tool$subscribersRetrieve } from "./tools/subscribersRetrieve.js";
 import { tool$subscribersSearch } from "./tools/subscribersSearch.js";
+import { tool$subscribersTopicsList } from "./tools/subscribersTopicsList.js";
 import { tool$subscribersUpsert } from "./tools/subscribersUpsert.js";
 import { tool$topicsCreate } from "./tools/topicsCreate.js";
 import { tool$topicsDelete } from "./tools/topicsDelete.js";
+import { tool$topicsGet } from "./tools/topicsGet.js";
 import { tool$topicsList } from "./tools/topicsList.js";
-import { tool$topicsRename } from "./tools/topicsRename.js";
-import { tool$topicsRetrieve } from "./tools/topicsRetrieve.js";
-import { tool$topicsSubscribersAssign } from "./tools/topicsSubscribersAssign.js";
-import { tool$topicsSubscribersRemove } from "./tools/topicsSubscribersRemove.js";
 import { tool$topicsSubscribersRetrieve } from "./tools/topicsSubscribersRetrieve.js";
+import { tool$topicsSubscriptionsCreate } from "./tools/topicsSubscriptionsCreate.js";
+import { tool$topicsSubscriptionsDelete } from "./tools/topicsSubscriptionsDelete.js";
+import { tool$topicsSubscriptionsList } from "./tools/topicsSubscriptionsList.js";
+import { tool$topicsUpdate } from "./tools/topicsUpdate.js";
 import { tool$trigger } from "./tools/trigger.js";
 import { tool$triggerBroadcast } from "./tools/triggerBroadcast.js";
 import { tool$triggerBulk } from "./tools/triggerBulk.js";
@@ -71,7 +73,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "Novu",
-    version: "0.6.2",
+    version: "1.0.0",
   });
 
   const client = new NovuCore({
@@ -80,7 +82,7 @@ export function createMCPServer(deps: {
     serverIdx: deps.serverIdx,
   });
 
-  const scopes = new Set(deps.scopes ?? mcpScopes);
+  const scopes = new Set(deps.scopes);
 
   const allowedTools = deps.allowedTools && new Set(deps.allowedTools);
   const tool = createRegisterTool(
@@ -113,6 +115,11 @@ export function createMCPServer(deps: {
   tool(tool$subscribersList);
   tool(tool$subscribersUpsert);
   tool(tool$subscribersCreateBulk);
+  tool(tool$topicsList);
+  tool(tool$topicsCreate);
+  tool(tool$topicsGet);
+  tool(tool$topicsUpdate);
+  tool(tool$topicsDelete);
   tool(tool$integrationsList);
   tool(tool$integrationsCreate);
   tool(tool$integrationsUpdate);
@@ -124,13 +131,9 @@ export function createMCPServer(deps: {
   tool(tool$messagesDeleteByTransactionId);
   tool(tool$notificationsList);
   tool(tool$notificationsRetrieve);
-  tool(tool$topicsCreate);
-  tool(tool$topicsList);
-  tool(tool$topicsDelete);
-  tool(tool$topicsRetrieve);
-  tool(tool$topicsRename);
   tool(tool$subscribersPreferencesList);
   tool(tool$subscribersPreferencesUpdate);
+  tool(tool$subscribersTopicsList);
   tool(tool$subscribersCredentialsUpdate);
   tool(tool$subscribersCredentialsAppend);
   tool(tool$subscribersCredentialsDelete);
@@ -142,12 +145,13 @@ export function createMCPServer(deps: {
   tool(tool$subscribersNotificationsFeed);
   tool(tool$subscribersNotificationsUnseenCount);
   tool(tool$subscribersPropertiesUpdateOnlineFlag);
+  tool(tool$topicsSubscriptionsList);
+  tool(tool$topicsSubscriptionsCreate);
+  tool(tool$topicsSubscriptionsDelete);
+  tool(tool$topicsSubscribersRetrieve);
   tool(tool$integrationsWebhooksRetrieve);
   tool(tool$notificationsStatsGraph);
   tool(tool$notificationsStatsRetrieve);
-  tool(tool$topicsSubscribersAssign);
-  tool(tool$topicsSubscribersRetrieve);
-  tool(tool$topicsSubscribersRemove);
 
   return server;
 }

package/src/mcp-server/tools/subscribersCreate.ts

@@ -17,7 +17,7 @@ export const tool$subscribersCreate: ToolDefinition<typeof args> = {
   name: "subscribers-create",
   description: `Create subscriber
 
-Create subscriber with the given data`,
+Create subscriber with the given data, if the subscriber already exists, it will be updated`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await subscribersCreate(

package/src/mcp-server/tools/subscribersMessagesMarkAll.ts

@@ -17,7 +17,7 @@ const args = {
 export const tool$subscribersMessagesMarkAll: ToolDefinition<typeof args> = {
   name: "subscribers-messages-mark-all",
   description:
-    `Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.`,
+    `Marks all the subscriber messages as read, unread, seen or unseen.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await subscribersMessagesMarkAll(

package/src/mcp-server/tools/subscribersTopicsList.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { subscribersTopicsList } from "../../funcs/subscribersTopicsList.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request:
+    operations.SubscribersControllerListSubscriberTopicsRequest$inboundSchema,
+};
+
+export const tool$subscribersTopicsList: ToolDefinition<typeof args> = {
+  name: "subscribers-topics-list",
+  description: `List topics a subscriber is subscribed to
+
+List topic subscriptions for a subscriber with pagination and filtering`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await subscribersTopicsList(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/topicsCreate.ts

@@ -8,20 +8,21 @@ import * as components from "../../models/components/index.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
 const args = {
-  createTopicRequestDto: components.CreateTopicRequestDto$inboundSchema,
+  createUpdateTopicRequestDto:
+    components.CreateUpdateTopicRequestDto$inboundSchema,
   idempotencyKey: z.string().optional(),
 };
 
 export const tool$topicsCreate: ToolDefinition<typeof args> = {
   name: "topics-create",
-  description: `Topic creation
+  description: `Create or update a topic
 
-Create a topic`,
+Creates a new topic if it does not exist, or updates an existing topic if it already exists`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await topicsCreate(
       client,
-      args.createTopicRequestDto,
+      args.createUpdateTopicRequestDto,
       args.idempotencyKey,
       { fetchOptions: { signal: ctx.signal } },
     ).$inspect();

package/src/mcp-server/tools/topicsDelete.ts

@@ -13,9 +13,7 @@ const args = {
 
 export const tool$topicsDelete: ToolDefinition<typeof args> = {
   name: "topics-delete",
-  description: `Delete topic
-
-Delete a topic by its topic key if it has no subscribers`,
+  description: `Delete topic by key`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await topicsDelete(
@@ -32,6 +30,8 @@ Delete a topic by its topic key if it has no subscribers`,
       };
     }
 
-    return formatResult(void 0, apiCall);
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
   },
 };

package/src/mcp-server/tools/{topicsRetrieve.ts → topicsGet.ts}

@@ -3,7 +3,7 @@
  */
 
 import * as z from "zod";
-import { topicsRetrieve } from "../../funcs/topicsRetrieve.js";
+import { topicsGet } from "../../funcs/topicsGet.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
 const args = {
@@ -11,14 +11,12 @@ const args = {
   idempotencyKey: z.string().optional(),
 };
 
-export const tool$topicsRetrieve: ToolDefinition<typeof args> = {
-  name: "topics-retrieve",
-  description: `Get topic
-
-Get a topic by its topic key`,
+export const tool$topicsGet: ToolDefinition<typeof args> = {
+  name: "topics-get",
+  description: `Get topic by key`,
   args,
   tool: async (client, args, ctx) => {
-    const [result, apiCall] = await topicsRetrieve(
+    const [result, apiCall] = await topicsGet(
       client,
       args.topicKey,
       args.idempotencyKey,

package/src/mcp-server/tools/topicsList.ts

@@ -12,9 +12,7 @@ const args = {
 
 export const tool$topicsList: ToolDefinition<typeof args> = {
   name: "topics-list",
-  description: `Get topic list filtered 
-
-Returns a list of topics that can be paginated using the \`page\` query parameter and filtered by the topic key with the \`key\` query parameter`,
+  description: `Get topics list`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await topicsList(

package/src/mcp-server/tools/{topicsSubscribersRemove.ts → topicsSubscriptionsCreate.ts}

@@ -3,27 +3,26 @@
  */
 
 import * as z from "zod";
-import { topicsSubscribersRemove } from "../../funcs/topicsSubscribersRemove.js";
+import { topicsSubscriptionsCreate } from "../../funcs/topicsSubscriptionsCreate.js";
 import * as components from "../../models/components/index.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
 const args = {
-  removeSubscribersRequestDto:
-    components.RemoveSubscribersRequestDto$inboundSchema,
+  createTopicSubscriptionsRequestDto:
+    components.CreateTopicSubscriptionsRequestDto$inboundSchema,
   topicKey: z.string(),
   idempotencyKey: z.string().optional(),
 };
 
-export const tool$topicsSubscribersRemove: ToolDefinition<typeof args> = {
-  name: "topics-subscribers-remove",
-  description: `Subscribers removal
-
-Remove subscribers from a topic`,
+export const tool$topicsSubscriptionsCreate: ToolDefinition<typeof args> = {
+  name: "topics-subscriptions-create",
+  description:
+    `Create topic subscriptions, if the topic does not exist, it will be created.`,
   args,
   tool: async (client, args, ctx) => {
-    const [result, apiCall] = await topicsSubscribersRemove(
+    const [result, apiCall] = await topicsSubscriptionsCreate(
       client,
-      args.removeSubscribersRequestDto,
+      args.createTopicSubscriptionsRequestDto,
       args.topicKey,
       args.idempotencyKey,
       { fetchOptions: { signal: ctx.signal } },
@@ -36,6 +35,8 @@ Remove subscribers from a topic`,
       };
     }
 
-    return formatResult(void 0, apiCall);
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
   },
 };

package/src/mcp-server/tools/{topicsSubscribersAssign.ts → topicsSubscriptionsDelete.ts}

@@ -3,26 +3,25 @@
  */
 
 import * as z from "zod";
-import { topicsSubscribersAssign } from "../../funcs/topicsSubscribersAssign.js";
+import { topicsSubscriptionsDelete } from "../../funcs/topicsSubscriptionsDelete.js";
 import * as components from "../../models/components/index.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
 const args = {
-  addSubscribersRequestDto: components.AddSubscribersRequestDto$inboundSchema,
+  deleteTopicSubscriptionsRequestDto:
+    components.DeleteTopicSubscriptionsRequestDto$inboundSchema,
   topicKey: z.string(),
   idempotencyKey: z.string().optional(),
 };
 
-export const tool$topicsSubscribersAssign: ToolDefinition<typeof args> = {
-  name: "topics-subscribers-assign",
-  description: `Subscribers addition
-
-Add subscribers to a topic by key`,
+export const tool$topicsSubscriptionsDelete: ToolDefinition<typeof args> = {
+  name: "topics-subscriptions-delete",
+  description: `Delete topic subscriptions`,
   args,
   tool: async (client, args, ctx) => {
-    const [result, apiCall] = await topicsSubscribersAssign(
+    const [result, apiCall] = await topicsSubscriptionsDelete(
       client,
-      args.addSubscribersRequestDto,
+      args.deleteTopicSubscriptionsRequestDto,
       args.topicKey,
       args.idempotencyKey,
       { fetchOptions: { signal: ctx.signal } },

package/src/mcp-server/tools/topicsSubscriptionsList.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { topicsSubscriptionsList } from "../../funcs/topicsSubscriptionsList.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request:
+    operations.TopicsControllerListTopicSubscriptionsRequest$inboundSchema,
+};
+
+export const tool$topicsSubscriptionsList: ToolDefinition<typeof args> = {
+  name: "topics-subscriptions-list",
+  description: `List topic subscriptions`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await topicsSubscriptionsList(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/{topicsRename.ts → topicsUpdate.ts}

@@ -3,26 +3,24 @@
  */
 
 import * as z from "zod";
-import { topicsRename } from "../../funcs/topicsRename.js";
+import { topicsUpdate } from "../../funcs/topicsUpdate.js";
 import * as components from "../../models/components/index.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
 const args = {
-  renameTopicRequestDto: components.RenameTopicRequestDto$inboundSchema,
+  updateTopicRequestDto: components.UpdateTopicRequestDto$inboundSchema,
   topicKey: z.string(),
   idempotencyKey: z.string().optional(),
 };
 
-export const tool$topicsRename: ToolDefinition<typeof args> = {
-  name: "topics-rename",
-  description: `Rename a topic
-
-Rename a topic by providing a new name`,
+export const tool$topicsUpdate: ToolDefinition<typeof args> = {
+  name: "topics-update",
+  description: `Update topic by key`,
   args,
   tool: async (client, args, ctx) => {
-    const [result, apiCall] = await topicsRename(
+    const [result, apiCall] = await topicsUpdate(
       client,
-      args.renameTopicRequestDto,
+      args.updateTopicRequestDto,
       args.topicKey,
       args.idempotencyKey,
       { fetchOptions: { signal: ctx.signal } },

package/src/mcp-server/tools.ts

@@ -102,12 +102,15 @@ export function createRegisterTool(
       return;
     }
 
-    const toolScopes = tool.scopes ?? [];
-    if (allowedScopes.size > 0 && toolScopes.length === 0) {
+    const scopes = tool.scopes ?? [];
+    if (allowedScopes.size > 0 && scopes.length === 0) {
       return;
     }
 
-    if (!toolScopes.every((s) => allowedScopes.has(s))) {
+    if (
+      allowedScopes.size > 0
+      && !scopes.every((s: MCPScope) => allowedScopes.has(s))
+    ) {
       return;
     }
 

package/src/models/components/activitynotificationjobresponsedto.ts

@@ -56,7 +56,7 @@ export type ActivityNotificationJobResponseDtoType = ClosedEnum<
 /**
  * Optional payload for the job
  */
-export type Payload = {};
+export type ActivityNotificationJobResponseDtoPayload = {};
 
 export type ActivityNotificationJobResponseDto = {
   /**
@@ -86,7 +86,7 @@ export type ActivityNotificationJobResponseDto = {
   /**
    * Optional payload for the job
    */
-  payload?: Payload | undefined;
+  payload?: ActivityNotificationJobResponseDtoPayload | undefined;
   /**
    * Provider ID of the job
    */
@@ -126,43 +126,62 @@ export namespace ActivityNotificationJobResponseDtoType$ {
 }
 
 /** @internal */
-export const Payload$inboundSchema: z.ZodType<Payload, z.ZodTypeDef, unknown> =
-  z.object({});
+export const ActivityNotificationJobResponseDtoPayload$inboundSchema: z.ZodType<
+  ActivityNotificationJobResponseDtoPayload,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
 
 /** @internal */
-export type Payload$Outbound = {};
+export type ActivityNotificationJobResponseDtoPayload$Outbound = {};
 
 /** @internal */
-export const Payload$outboundSchema: z.ZodType<
-  Payload$Outbound,
-  z.ZodTypeDef,
-  Payload
-> = z.object({});
+export const ActivityNotificationJobResponseDtoPayload$outboundSchema:
+  z.ZodType<
+    ActivityNotificationJobResponseDtoPayload$Outbound,
+    z.ZodTypeDef,
+    ActivityNotificationJobResponseDtoPayload
+  > = z.object({});
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace Payload$ {
-  /** @deprecated use `Payload$inboundSchema` instead. */
-  export const inboundSchema = Payload$inboundSchema;
-  /** @deprecated use `Payload$outboundSchema` instead. */
-  export const outboundSchema = Payload$outboundSchema;
-  /** @deprecated use `Payload$Outbound` instead. */
-  export type Outbound = Payload$Outbound;
+export namespace ActivityNotificationJobResponseDtoPayload$ {
+  /** @deprecated use `ActivityNotificationJobResponseDtoPayload$inboundSchema` instead. */
+  export const inboundSchema =
+    ActivityNotificationJobResponseDtoPayload$inboundSchema;
+  /** @deprecated use `ActivityNotificationJobResponseDtoPayload$outboundSchema` instead. */
+  export const outboundSchema =
+    ActivityNotificationJobResponseDtoPayload$outboundSchema;
+  /** @deprecated use `ActivityNotificationJobResponseDtoPayload$Outbound` instead. */
+  export type Outbound = ActivityNotificationJobResponseDtoPayload$Outbound;
 }
 
-export function payloadToJSON(payload: Payload): string {
-  return JSON.stringify(Payload$outboundSchema.parse(payload));
+export function activityNotificationJobResponseDtoPayloadToJSON(
+  activityNotificationJobResponseDtoPayload:
+    ActivityNotificationJobResponseDtoPayload,
+): string {
+  return JSON.stringify(
+    ActivityNotificationJobResponseDtoPayload$outboundSchema.parse(
+      activityNotificationJobResponseDtoPayload,
+    ),
+  );
 }
 
-export function payloadFromJSON(
+export function activityNotificationJobResponseDtoPayloadFromJSON(
   jsonString: string,
-): SafeParseResult<Payload, SDKValidationError> {
+): SafeParseResult<
+  ActivityNotificationJobResponseDtoPayload,
+  SDKValidationError
+> {
   return safeParse(
     jsonString,
-    (x) => Payload$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Payload' from JSON`,
+    (x) =>
+      ActivityNotificationJobResponseDtoPayload$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ActivityNotificationJobResponseDtoPayload' from JSON`,
   );
 }
 
@@ -180,7 +199,8 @@ export const ActivityNotificationJobResponseDto$inboundSchema: z.ZodType<
   ),
   step: ActivityNotificationStepResponseDto$inboundSchema,
   overrides: z.record(z.any()).optional(),
-  payload: z.lazy(() => Payload$inboundSchema).optional(),
+  payload: z.lazy(() => ActivityNotificationJobResponseDtoPayload$inboundSchema)
+    .optional(),
   providerId: ProvidersIdEnum$inboundSchema,
   status: z.string(),
   updatedAt: z.string().optional(),
@@ -200,7 +220,7 @@ export type ActivityNotificationJobResponseDto$Outbound = {
   >;
   step: ActivityNotificationStepResponseDto$Outbound;
   overrides?: { [k: string]: any } | undefined;
-  payload?: Payload$Outbound | undefined;
+  payload?: ActivityNotificationJobResponseDtoPayload$Outbound | undefined;
   providerId: string;
   status: string;
   updatedAt?: string | undefined;
@@ -220,7 +240,9 @@ export const ActivityNotificationJobResponseDto$outboundSchema: z.ZodType<
   ),
   step: ActivityNotificationStepResponseDto$outboundSchema,
   overrides: z.record(z.any()).optional(),
-  payload: z.lazy(() => Payload$outboundSchema).optional(),
+  payload: z.lazy(() =>
+    ActivityNotificationJobResponseDtoPayload$outboundSchema
+  ).optional(),
   providerId: ProvidersIdEnum$outboundSchema,
   status: z.string(),
   updatedAt: z.string().optional(),

package/src/models/components/activitynotificationresponsedto.ts

@@ -25,6 +25,12 @@ import {
   ActivityNotificationTemplateResponseDto$Outbound,
   ActivityNotificationTemplateResponseDto$outboundSchema,
 } from "./activitynotificationtemplateresponsedto.js";
+import {
+  ActivityTopicDto,
+  ActivityTopicDto$inboundSchema,
+  ActivityTopicDto$Outbound,
+  ActivityTopicDto$outboundSchema,
+} from "./activitytopicdto.js";
 import {
   StepTypeEnum,
   StepTypeEnum$inboundSchema,
@@ -112,6 +118,10 @@ export type ActivityNotificationResponseDto = {
    * To field for subscriber definition
    */
   to?: ActivityNotificationResponseDtoTo | undefined;
+  /**
+   * Topics of the notification
+   */
+  topics?: Array<ActivityTopicDto> | undefined;
 };
 
 /** @internal */
@@ -288,6 +298,7 @@ export const ActivityNotificationResponseDto$inboundSchema: z.ZodType<
   tags: z.array(z.string()).optional(),
   controls: z.lazy(() => Controls$inboundSchema).optional(),
   to: z.lazy(() => ActivityNotificationResponseDtoTo$inboundSchema).optional(),
+  topics: z.array(ActivityTopicDto$inboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",
@@ -318,6 +329,7 @@ export type ActivityNotificationResponseDto$Outbound = {
   tags?: Array<string> | undefined;
   controls?: Controls$Outbound | undefined;
   to?: ActivityNotificationResponseDtoTo$Outbound | undefined;
+  topics?: Array<ActivityTopicDto$Outbound> | undefined;
 };
 
 /** @internal */
@@ -345,6 +357,7 @@ export const ActivityNotificationResponseDto$outboundSchema: z.ZodType<
   tags: z.array(z.string()).optional(),
   controls: z.lazy(() => Controls$outboundSchema).optional(),
   to: z.lazy(() => ActivityNotificationResponseDtoTo$outboundSchema).optional(),
+  topics: z.array(ActivityTopicDto$outboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     id: "_id",