@novu/api 0.5.0 → 0.6.0

package/src/lib/config.ts

@@ -55,7 +55,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
-  sdkVersion: "0.5.0",
-  genVersion: "2.539.0",
-  userAgent: "speakeasy-sdk/typescript 0.5.0 2.539.0 1.0 @novu/api",
+  sdkVersion: "0.6.0",
+  genVersion: "2.558.2",
+  userAgent: "speakeasy-sdk/typescript 0.6.0 2.558.2 1.0 @novu/api",
 } as const;

package/src/lib/sdks.ts

@@ -191,14 +191,9 @@ export class ClientSDK {
 
     if (conf.body instanceof ReadableStream) {
       if (!fetchOptions) {
-        fetchOptions = {
-          // @ts-expect-error see https://github.com/node-fetch/node-fetch/issues/1769
-          duplex: "half",
-        };
-      } else {
-        // @ts-expect-error see https://github.com/node-fetch/node-fetch/issues/1769
-        fetchOptions.duplex = "half";
+        fetchOptions = {};
       }
+      Object.assign(fetchOptions, { duplex: "half" });
     }
 
     let input;

package/src/lib/security.ts

@@ -3,6 +3,7 @@
  */
 
 import * as components from "../models/components/index.js";
+
 type OAuth2PasswordFlow = {
   username: string;
   password?: string | undefined;
@@ -84,7 +85,9 @@ type SecurityInputOAuth2ClientCredentials = {
   value:
     | { clientID?: string | undefined; clientSecret?: string | undefined }
     | null
+    | string
     | undefined;
+  fieldName?: string;
 };
 
 type SecurityInputOAuth2PasswordCredentials = {
@@ -93,13 +96,13 @@ type SecurityInputOAuth2PasswordCredentials = {
     | string
     | null
     | undefined;
-  fieldName: string;
+  fieldName?: string;
 };
 
 type SecurityInputCustom = {
   type: "http:custom";
   value: any | null | undefined;
-  fieldName: string;
+  fieldName?: string;
 };
 
 export type SecurityInput =
@@ -136,6 +139,9 @@ export function resolveSecurity(
           typeof o.value === "string" && !!o.value
         );
       } else if (o.type === "oauth2:client_credentials") {
+        if (typeof o.value == "string") {
+          return !!o.value;
+        }
         return o.value.clientID != null || o.value.clientSecret != null;
       } else if (typeof o.value === "string") {
         return !!o.value;
@@ -224,7 +230,9 @@ function applyBearer(
     value = `Bearer ${value}`;
   }
 
-  state.headers[spec.fieldName] = value;
+  if (spec.fieldName !== undefined) {
+    state.headers[spec.fieldName] = value;
+  }
 }
 
 export function resolveGlobalSecurity(

package/src/mcp-server/extensions.ts

@@ -0,0 +1,17 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ZodRawShape } from "zod";
+import { PromptArgsRawShape, PromptDefinition } from "./prompts.js";
+import { ResourceDefinition, ResourceTemplateDefinition } from "./resources.js";
+import { ToolDefinition } from "./tools.js";
+
+export type Register = {
+  tool: <A extends ZodRawShape | undefined>(def: ToolDefinition<A>) => void;
+  resource: (def: ResourceDefinition) => void;
+  resourceTemplate: (def: ResourceTemplateDefinition) => void;
+  prompt: <A extends PromptArgsRawShape | undefined>(
+    prompt: PromptDefinition<A>,
+  ) => void;
+};

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

@@ -19,7 +19,7 @@ const routes = buildRouteMap({
 export const app = buildApplication(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "0.5.0",
+    currentVersion: "0.6.0",
   },
 });
 

package/src/mcp-server/prompts.ts

@@ -0,0 +1,110 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
+import { GetPromptResult } from "@modelcontextprotocol/sdk/types.js";
+import {
+  objectOutputType,
+  ZodOptional,
+  ZodType,
+  ZodTypeAny,
+  ZodTypeDef,
+} from "zod";
+import { NovuCore } from "../core.js";
+import { ConsoleLogger } from "./console-logger.js";
+import { MCPScope } from "./scopes.js";
+
+// '@modelcontextprotocol/sdk' currently does not export this type
+export type PromptArgsRawShape = {
+  [k: string]:
+    | ZodType<string, ZodTypeDef, string>
+    | ZodOptional<ZodType<string, ZodTypeDef, string>>;
+};
+
+export type PromptDefinition<
+  Args extends undefined | PromptArgsRawShape = undefined,
+> = Args extends PromptArgsRawShape ? {
+    name: string;
+    description?: string;
+    scopes?: MCPScope[];
+    args: Args;
+    prompt: (
+      client: NovuCore,
+      args: objectOutputType<Args, ZodTypeAny>,
+      extra: RequestHandlerExtra,
+    ) => GetPromptResult | Promise<GetPromptResult>;
+  }
+  : {
+    name: string;
+    description?: string;
+    scopes?: MCPScope[];
+    args?: undefined;
+    prompt: (
+      client: NovuCore,
+      extra: RequestHandlerExtra,
+    ) => GetPromptResult | Promise<GetPromptResult>;
+  };
+
+// Optional function to assist with formatting prompt results
+export async function formatResult(value: string): Promise<GetPromptResult> {
+  return {
+    messages: [
+      {
+        role: "user",
+        content: {
+          type: "text",
+          text: value,
+        },
+      },
+    ],
+  };
+}
+
+export function createRegisterPrompt(
+  logger: ConsoleLogger,
+  server: McpServer,
+  sdk: NovuCore,
+  allowedScopes: Set<MCPScope>,
+): <A extends PromptArgsRawShape | undefined>(
+  prompt: PromptDefinition<A>,
+) => void {
+  return <A extends PromptArgsRawShape | undefined>(
+    prompt: PromptDefinition<A>,
+  ): void => {
+    const scopes = prompt.scopes ?? [];
+    if (!scopes.every((s: MCPScope) => allowedScopes.has(s))) {
+      return;
+    }
+
+    if (prompt.args) {
+      if (prompt.description) {
+        server.prompt(
+          prompt.name,
+          prompt.description,
+          prompt.args,
+          async (args, ctx) => prompt.prompt(sdk, args, ctx),
+        );
+      } else {
+        server.prompt(
+          prompt.name,
+          prompt.args,
+          async (args, ctx) => prompt.prompt(sdk, args, ctx),
+        );
+      }
+    } else {
+      if (prompt.description) {
+        server.prompt(
+          prompt.name,
+          prompt.description,
+          async (ctx) => prompt.prompt(sdk, ctx),
+        );
+      } else {
+        server.prompt(prompt.name, async (ctx) => prompt.prompt(sdk, ctx));
+      }
+    }
+
+    logger.debug("Registered prompt", { name: prompt.name });
+  };
+}

package/src/mcp-server/resources.ts

@@ -2,12 +2,16 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { ResourceTemplate } from "@modelcontextprotocol/sdk/server/mcp.js";
+import {
+  McpServer,
+  ResourceMetadata,
+  ResourceTemplate,
+} from "@modelcontextprotocol/sdk/server/mcp.js";
 import { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
 import { Variables } from "@modelcontextprotocol/sdk/shared/uriTemplate.js";
 import { ReadResourceResult } from "@modelcontextprotocol/sdk/types.js";
 import { NovuCore } from "../core.js";
-import { Result } from "../types/fp.js";
+import { ConsoleLogger } from "./console-logger.js";
 import { MCPScope } from "./scopes.js";
 import { isAsyncIterable, isBinaryData, valueToBase64 } from "./shared.js";
 
@@ -19,7 +23,8 @@ export type ReadResourceCallback = (
 
 export type ResourceDefinition = {
   name: string;
-  description: string;
+  description?: string;
+  metadata?: ResourceMetadata;
   scopes?: MCPScope[];
   resource: string;
   read: ReadResourceCallback;
@@ -35,30 +40,28 @@ export type ReadResourceTemplateCallback = (
 export type ResourceTemplateDefinition = {
   name: string;
   description: string;
+  metadata?: ResourceMetadata;
   scopes?: MCPScope[];
   resource: ResourceTemplate;
   read: ReadResourceTemplateCallback;
 };
 
+// Optional function to assist with formatting resource results
 export async function formatResult(
-  result: Result<unknown, Error>,
+  value: unknown,
   uri: URL,
-  init: { response?: Response | undefined },
+  init: { mimeType?: string | undefined; response?: Response | undefined },
 ): Promise<ReadResourceResult> {
-  if (!result.ok) {
-    throw result.error;
-  }
-
-  const { value } = result;
   if (typeof value === "undefined") {
     return { contents: [] };
   }
 
-  const { response } = init;
-  const mimeType = response?.headers.get("content-type") ?? "";
   let contents: ReadResourceResult["contents"] = [];
 
-  if (mimeType.search(/\bjson\b/g)) {
+  const mimeType = init.mimeType ?? init.response?.headers.get("content-type")
+    ?? "";
+
+  if (mimeType.search(/\bjson\b/g) !== -1) {
     contents = [{ uri: uri.toString(), mimeType, text: JSON.stringify(value) }];
   } else if (
     mimeType.startsWith("text/event-stream")
@@ -71,7 +74,10 @@ export async function formatResult(
         text: await stringifySSEToJSON(value),
       },
     ];
-  } else if (mimeType.startsWith("text/") && typeof value === "string") {
+  } else if (
+    (mimeType.startsWith("text/") || mimeType.startsWith("application/"))
+    && typeof value === "string"
+  ) {
     contents = [{ uri: uri.toString(), mimeType, text: value }];
   } else if (isBinaryData(value)) {
     const blob = await valueToBase64(value);
@@ -94,3 +100,59 @@ async function stringifySSEToJSON(
 
   return JSON.stringify(payloads);
 }
+
+export function createRegisterResource(
+  logger: ConsoleLogger,
+  server: McpServer,
+  sdk: NovuCore,
+  allowedScopes: Set<MCPScope>,
+): (resource: ResourceDefinition) => void {
+  return (resource: ResourceDefinition): void => {
+    const scopes = resource.scopes ?? [];
+    if (!scopes.every((s: MCPScope) => allowedScopes.has(s))) {
+      return;
+    }
+
+    const metadata: ResourceMetadata = {
+      ...resource.metadata,
+      description: resource.description,
+    };
+
+    server.resource(
+      resource.name,
+      resource.resource,
+      metadata,
+      async (uri, ctx) => resource.read(sdk, uri, ctx),
+    );
+
+    logger.debug("Registered resource", { name: resource.name });
+  };
+}
+
+export function createRegisterResourceTemplate(
+  logger: ConsoleLogger,
+  server: McpServer,
+  sdk: NovuCore,
+  allowedScopes: Set<MCPScope>,
+): (resource: ResourceTemplateDefinition) => void {
+  return (resource: ResourceTemplateDefinition): void => {
+    const scopes = resource.scopes ?? [];
+    if (!scopes.every((s: MCPScope) => allowedScopes.has(s))) {
+      return;
+    }
+
+    const metadata: ResourceMetadata = {
+      ...resource.metadata,
+      description: resource.description,
+    };
+
+    server.resource(
+      resource.name,
+      resource.resource,
+      metadata,
+      async (uri, vars, ctx) => resource.read(sdk, uri, vars, ctx),
+    );
+
+    logger.debug("Registered resource template", { name: resource.name });
+  };
+}

package/src/mcp-server/server.ts

@@ -6,6 +6,11 @@ import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { NovuCore } from "../core.js";
 import { SDKOptions } from "../lib/config.js";
 import type { ConsoleLogger } from "./console-logger.js";
+import { createRegisterPrompt } from "./prompts.js";
+import {
+  createRegisterResource,
+  createRegisterResourceTemplate,
+} from "./resources.js";
 import { MCPScope, mcpScopes } from "./scopes.js";
 import { createRegisterTool } from "./tools.js";
 import { tool$cancel } from "./tools/cancel.js";
@@ -65,7 +70,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "Novu",
-    version: "0.5.0",
+    version: "0.6.0",
   });
 
   const client = new NovuCore({
@@ -73,7 +78,9 @@ export function createMCPServer(deps: {
     serverURL: deps.serverURL,
     serverIdx: deps.serverIdx,
   });
+
   const scopes = new Set(deps.scopes ?? mcpScopes);
+
   const allowedTools = deps.allowedTools && new Set(deps.allowedTools);
   const tool = createRegisterTool(
     deps.logger,
@@ -82,50 +89,60 @@ export function createMCPServer(deps: {
     scopes,
     allowedTools,
   );
+  const resource = createRegisterResource(deps.logger, server, client, scopes);
+  const resourceTemplate = createRegisterResourceTemplate(
+    deps.logger,
+    server,
+    client,
+    scopes,
+  );
+  const prompt = createRegisterPrompt(deps.logger, server, client, scopes);
+  const register = { tool, resource, resourceTemplate, prompt };
+  void register; // suppress unused warnings
 
   tool(tool$trigger);
-  tool(tool$triggerBulk);
-  tool(tool$triggerBroadcast);
   tool(tool$cancel);
-  tool(tool$notificationsList);
-  tool(tool$notificationsRetrieve);
-  tool(tool$integrationsList);
-  tool(tool$integrationsCreate);
-  tool(tool$integrationsListActive);
-  tool(tool$integrationsUpdate);
-  tool(tool$integrationsDelete);
-  tool(tool$integrationsSetAsPrimary);
-  tool(tool$subscribersList);
-  tool(tool$subscribersCreateBulk);
+  tool(tool$triggerBroadcast);
+  tool(tool$triggerBulk);
   tool(tool$subscribersSearch);
   tool(tool$subscribersCreate);
   tool(tool$subscribersRetrieve);
   tool(tool$subscribersPatch);
   tool(tool$subscribersDelete);
+  tool(tool$subscribersList);
+  tool(tool$subscribersCreateBulk);
+  tool(tool$integrationsList);
+  tool(tool$integrationsCreate);
+  tool(tool$integrationsUpdate);
+  tool(tool$integrationsDelete);
+  tool(tool$integrationsSetAsPrimary);
+  tool(tool$integrationsListActive);
   tool(tool$messagesRetrieve);
   tool(tool$messagesDelete);
   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$notificationsStatsRetrieve);
-  tool(tool$notificationsStatsGraph);
-  tool(tool$integrationsWebhooksRetrieve);
+  tool(tool$subscribersPreferencesList);
+  tool(tool$subscribersPreferencesUpdate);
   tool(tool$subscribersCredentialsUpdate);
   tool(tool$subscribersCredentialsAppend);
   tool(tool$subscribersCredentialsDelete);
-  tool(tool$subscribersPropertiesUpdateOnlineFlag);
+  tool(tool$subscribersAuthenticationChatAccessOauth);
+  tool(tool$subscribersAuthenticationChatAccessOauthCallBack);
+  tool(tool$subscribersMessagesUpdateAsSeen);
+  tool(tool$subscribersMessagesMarkAll);
+  tool(tool$subscribersMessagesMarkAllAs);
   tool(tool$subscribersNotificationsFeed);
   tool(tool$subscribersNotificationsUnseenCount);
-  tool(tool$subscribersMessagesMarkAllAs);
-  tool(tool$subscribersMessagesMarkAll);
-  tool(tool$subscribersMessagesUpdateAsSeen);
-  tool(tool$subscribersAuthenticationChatAccessOauthCallBack);
-  tool(tool$subscribersAuthenticationChatAccessOauth);
-  tool(tool$subscribersPreferencesList);
-  tool(tool$subscribersPreferencesUpdate);
+  tool(tool$subscribersPropertiesUpdateOnlineFlag);
+  tool(tool$integrationsWebhooksRetrieve);
+  tool(tool$notificationsStatsGraph);
+  tool(tool$notificationsStatsRetrieve);
   tool(tool$topicsSubscribersAssign);
   tool(tool$topicsSubscribersRetrieve);
   tool(tool$topicsSubscribersRemove);

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

@@ -14,7 +14,7 @@ const args = {
 };
 
 export const tool$integrationsCreate: ToolDefinition<typeof args> = {
-  name: "integrations_create",
+  name: "integrations-create",
   description: `Create integration
 
 Create an integration for the current environment the user is based on the API key provided`,

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

@@ -12,7 +12,7 @@ const args = {
 };
 
 export const tool$integrationsDelete: ToolDefinition<typeof args> = {
-  name: "integrations_delete",
+  name: "integrations-delete",
   description: `Delete integration`,
   args,
   tool: async (client, args, ctx) => {

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

@@ -11,7 +11,7 @@ const args = {
 };
 
 export const tool$integrationsList: ToolDefinition<typeof args> = {
-  name: "integrations_list",
+  name: "integrations-list",
   description: `Get integrations
 
 Return all the integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change`,

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

@@ -11,7 +11,7 @@ const args = {
 };
 
 export const tool$integrationsListActive: ToolDefinition<typeof args> = {
-  name: "integrations_list-active",
+  name: "integrations-list-active",
   description: `Get active integrations
 
 Return all the active integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change`,

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

@@ -12,7 +12,7 @@ const args = {
 };
 
 export const tool$integrationsSetAsPrimary: ToolDefinition<typeof args> = {
-  name: "integrations_set-as-primary",
+  name: "integrations-set-as-primary",
   description: `Set integration as primary`,
   args,
   tool: async (client, args, ctx) => {

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

@@ -15,7 +15,7 @@ const args = {
 };
 
 export const tool$integrationsUpdate: ToolDefinition<typeof args> = {
-  name: "integrations_update",
+  name: "integrations-update",
   description: `Update integration`,
   args,
   tool: async (client, args, ctx) => {

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

@@ -12,7 +12,7 @@ const args = {
 };
 
 export const tool$integrationsWebhooksRetrieve: ToolDefinition<typeof args> = {
-  name: "integrations-webhooks_retrieve",
+  name: "integrations-webhooks-retrieve",
   description: `Get webhook support status for provider
 
 Return the status of the webhook for this provider, if it is supported or if it is not based on a boolean value`,

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

@@ -12,7 +12,7 @@ const args = {
 };
 
 export const tool$messagesDelete: ToolDefinition<typeof args> = {
-  name: "messages_delete",
+  name: "messages-delete",
   description: `Delete message
 
 Deletes a message entity from the Novu platform`,

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

@@ -14,7 +14,7 @@ const args = {
 };
 
 export const tool$messagesDeleteByTransactionId: ToolDefinition<typeof args> = {
-  name: "messages_delete-by-transaction-id",
+  name: "messages-delete-by-transaction-id",
   description: `Delete messages by transactionId
 
 Deletes messages entity from the Novu platform using TransactionId of message`,

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

@@ -11,7 +11,7 @@ const args = {
 };
 
 export const tool$messagesRetrieve: ToolDefinition<typeof args> = {
-  name: "messages_retrieve",
+  name: "messages-retrieve",
   description: `Get messages
 
 Returns a list of messages, could paginate using the \`page\` query parameter`,

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

@@ -12,7 +12,7 @@ const args = {
 };
 
 export const tool$notificationsList: ToolDefinition<typeof args> = {
-  name: "notifications_list",
+  name: "notifications-list",
   description: `Get notifications`,
   args,
   tool: async (client, args, ctx) => {

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

@@ -12,7 +12,7 @@ const args = {
 };
 
 export const tool$notificationsRetrieve: ToolDefinition<typeof args> = {
-  name: "notifications_retrieve",
+  name: "notifications-retrieve",
   description: `Get notification`,
   args,
   tool: async (client, args, ctx) => {

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

@@ -12,7 +12,7 @@ const args = {
 };
 
 export const tool$notificationsStatsGraph: ToolDefinition<typeof args> = {
-  name: "notifications-stats_graph",
+  name: "notifications-stats-graph",
   description: `Get notification graph statistics`,
   args,
   tool: async (client, args, ctx) => {

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

@@ -11,7 +11,7 @@ const args = {
 };
 
 export const tool$notificationsStatsRetrieve: ToolDefinition<typeof args> = {
-  name: "notifications-stats_retrieve",
+  name: "notifications-stats-retrieve",
   description: `Get notification statistics`,
   args,
   tool: async (client, args, ctx) => {

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

@@ -14,7 +14,7 @@ const args = {
 export const tool$subscribersAuthenticationChatAccessOauth: ToolDefinition<
   typeof args
 > = {
-  name: "subscribers-authentication_chat-access-oauth",
+  name: "subscribers-authentication-chat-access-oauth",
   description: `Handle chat oauth`,
   args,
   tool: async (client, args, ctx) => {

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

@@ -13,7 +13,7 @@ const args = {
 
 export const tool$subscribersAuthenticationChatAccessOauthCallBack:
   ToolDefinition<typeof args> = {
-    name: "subscribers-authentication_chat-access-oauth-call-back",
+    name: "subscribers-authentication-chat-access-oauth-call-back",
     description: `Handle providers oauth redirect`,
     args,
     tool: async (client, args, ctx) => {

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

@@ -14,7 +14,7 @@ const args = {
 };
 
 export const tool$subscribersCreate: ToolDefinition<typeof args> = {
-  name: "subscribers_create",
+  name: "subscribers-create",
   description: `Create subscriber
 
 Create subscriber with the given data`,

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

@@ -13,7 +13,7 @@ const args = {
 };
 
 export const tool$subscribersCreateBulk: ToolDefinition<typeof args> = {
-  name: "subscribers_create-bulk",
+  name: "subscribers-create-bulk",
   description: `Bulk create subscribers
 
 

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

@@ -15,7 +15,7 @@ const args = {
 };
 
 export const tool$subscribersCredentialsAppend: ToolDefinition<typeof args> = {
-  name: "subscribers-credentials_append",
+  name: "subscribers-credentials-append",
   description: `Modify subscriber credentials
 
 Subscriber credentials associated to the delivery methods such as slack and push tokens.