@novu/api 0.2.1 → 0.4.0

package/src/funcs/trigger.ts

@@ -22,6 +22,7 @@ import * as errors from "../models/errors/index.js";
 import { SDKError } from "../models/errors/sdkerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
@@ -33,12 +34,12 @@ import { Result } from "../types/fp.js";
  *     The trigger identifier is used to match the particular workflow associated with it.
  *     Additional information can be passed according the body interface below.
  */
-export async function trigger(
+export function trigger(
   client: NovuCore,
   triggerEventRequestDto: components.TriggerEventRequestDto,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.EventsControllerTriggerResponse,
     | errors.ErrorDto
@@ -53,6 +54,38 @@ export async function trigger(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    triggerEventRequestDto,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  triggerEventRequestDto: components.TriggerEventRequestDto,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.EventsControllerTriggerResponse,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const input: operations.EventsControllerTriggerRequest = {
     triggerEventRequestDto: triggerEventRequestDto,
@@ -66,7 +99,7 @@ export async function trigger(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = encodeJSON("body", payload.TriggerEventRequestDto, {
@@ -90,7 +123,7 @@ export async function trigger(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    baseURL: options?.serverURL ?? "",
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "EventsController_trigger",
     oAuth2Scopes: [],
 
@@ -123,7 +156,7 @@ export async function trigger(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -150,7 +183,7 @@ export async function trigger(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -190,8 +223,8 @@ export async function trigger(
     M.fail("5XX"),
   )(response, { extraFields: responseFields });
   if (!result.ok) {
-    return result;
+    return [result, { status: "complete", request: req, response }];
   }
 
-  return result;
+  return [result, { status: "complete", request: req, response }];
 }

package/src/funcs/triggerBroadcast.ts

@@ -22,6 +22,7 @@ import * as errors from "../models/errors/index.js";
 import { SDKError } from "../models/errors/sdkerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
@@ -31,12 +32,12 @@ import { Result } from "../types/fp.js";
  * Trigger a broadcast event to all existing subscribers, could be used to send announcements, etc.
  *       In the future could be used to trigger events to a subset of subscribers based on defined filters.
  */
-export async function triggerBroadcast(
+export function triggerBroadcast(
   client: NovuCore,
   triggerEventToAllRequestDto: components.TriggerEventToAllRequestDto,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.EventsControllerBroadcastEventToAllResponse,
     | errors.ErrorDto
@@ -51,6 +52,38 @@ export async function triggerBroadcast(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    triggerEventToAllRequestDto,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  triggerEventToAllRequestDto: components.TriggerEventToAllRequestDto,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.EventsControllerBroadcastEventToAllResponse,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const input: operations.EventsControllerBroadcastEventToAllRequest = {
     triggerEventToAllRequestDto: triggerEventToAllRequestDto,
@@ -65,7 +98,7 @@ export async function triggerBroadcast(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = encodeJSON("body", payload.TriggerEventToAllRequestDto, {
@@ -89,7 +122,7 @@ export async function triggerBroadcast(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    baseURL: options?.serverURL ?? "",
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "EventsController_broadcastEventToAll",
     oAuth2Scopes: [],
 
@@ -122,7 +155,7 @@ export async function triggerBroadcast(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -149,7 +182,7 @@ export async function triggerBroadcast(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -190,8 +223,8 @@ export async function triggerBroadcast(
     M.fail("5XX"),
   )(response, { extraFields: responseFields });
   if (!result.ok) {
-    return result;
+    return [result, { status: "complete", request: req, response }];
   }
 
-  return result;
+  return [result, { status: "complete", request: req, response }];
 }

package/src/funcs/triggerBulk.ts

@@ -22,6 +22,7 @@ import * as errors from "../models/errors/index.js";
 import { SDKError } from "../models/errors/sdkerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
@@ -32,12 +33,12 @@ import { Result } from "../types/fp.js";
  *       Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API.
  *       The bulk API is limited to 100 events per request.
  */
-export async function triggerBulk(
+export function triggerBulk(
   client: NovuCore,
   bulkTriggerEventDto: components.BulkTriggerEventDto,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.EventsControllerTriggerBulkResponse,
     | errors.ErrorDto
@@ -52,6 +53,38 @@ export async function triggerBulk(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    bulkTriggerEventDto,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  bulkTriggerEventDto: components.BulkTriggerEventDto,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.EventsControllerTriggerBulkResponse,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const input: operations.EventsControllerTriggerBulkRequest = {
     bulkTriggerEventDto: bulkTriggerEventDto,
@@ -65,7 +98,7 @@ export async function triggerBulk(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = encodeJSON("body", payload.BulkTriggerEventDto, {
@@ -89,7 +122,7 @@ export async function triggerBulk(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    baseURL: options?.serverURL ?? "",
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "EventsController_triggerBulk",
     oAuth2Scopes: [],
 
@@ -122,7 +155,7 @@ export async function triggerBulk(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -149,7 +182,7 @@ export async function triggerBulk(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -189,8 +222,8 @@ export async function triggerBulk(
     M.fail("5XX"),
   )(response, { extraFields: responseFields });
   if (!result.ok) {
-    return result;
+    return [result, { status: "complete", request: req, response }];
   }
 
-  return result;
+  return [result, { status: "complete", request: req, response }];
 }

package/src/lib/config.ts

@@ -16,17 +16,17 @@ export const ServerList = [
 ] as const;
 
 export type SDKOptions = {
-  secretKey?: string | (() => Promise<string>);
+  secretKey?: string | (() => Promise<string>) | undefined;
 
   httpClient?: HTTPClient;
   /**
    * Allows overriding the default server used by the SDK
    */
-  serverIdx?: number;
+  serverIdx?: number | undefined;
   /**
    * Allows overriding the default server URL used by the SDK
    */
-  serverURL?: string;
+  serverURL?: string | undefined;
   /**
    * Allows overriding the default retry config used by the SDK
    */
@@ -55,7 +55,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
-  sdkVersion: "0.2.1",
-  genVersion: "2.512.0",
-  userAgent: "speakeasy-sdk/typescript 0.2.1 2.512.0 1.0 @novu/api",
+  sdkVersion: "0.4.0",
+  genVersion: "2.524.1",
+  userAgent: "speakeasy-sdk/typescript 0.4.0 2.524.1 1.0 @novu/api",
 } as const;

package/src/lib/files.ts

@@ -36,5 +36,5 @@ export async function readableStreamToArrayBuffer(
     offset += chunk.length;
   }
 
-  return concatenatedChunks.buffer;
+  return concatenatedChunks.buffer as ArrayBuffer;
 }

package/src/lib/primitives.ts

@@ -134,3 +134,17 @@ export function compactMap<T>(
 
   return out;
 }
+
+export function allRequired<V extends Record<string, unknown>>(
+  v: V,
+):
+  | {
+      [K in keyof V]: NonNullable<V[K]>;
+    }
+  | undefined {
+  if (Object.values(v).every((x) => x == null)) {
+    return void 0;
+  }
+
+  return v as ReturnType<typeof allRequired<V>>;
+}

package/src/lib/sdks.ts

@@ -78,7 +78,7 @@ export class ClientSDK {
   readonly #httpClient: HTTPClient;
   readonly #hooks: SDKHooks;
   readonly #logger?: Logger | undefined;
-  protected readonly _baseURL: URL | null;
+  public readonly _baseURL: URL | null;
   public readonly _options: SDKOptions & { hooks?: SDKHooks };
 
   constructor(options: SDKOptions = {}) {

package/src/mcp-server/cli/start/command.ts

@@ -0,0 +1,98 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { buildCommand } from "@stricli/core";
+import { numberParser } from "@stricli/core";
+import * as z from "zod";
+import { consoleLoggerLevels } from "../../console-logger.js";
+import { mcpScopes } from "../../scopes.js";
+
+export const startCommand = buildCommand({
+  loader: async () => {
+    const { main } = await import("./impl.js");
+    return main;
+  },
+  parameters: {
+    flags: {
+      transport: {
+        kind: "enum",
+        brief: "The transport to use for communicating with the server",
+        default: "stdio",
+        values: ["stdio", "sse"],
+      },
+      port: {
+        kind: "parsed",
+        brief: "The port to use when the SSE transport is enabled",
+        default: "2718",
+        parse: (val: string) =>
+          z.coerce.number().int().gte(0).lt(65536).parse(val),
+      },
+      ...(mcpScopes.length
+        ? {
+          scope: {
+            kind: "enum",
+            brief:
+              "Mount tools/resources that match given scope (repeatable flag)",
+            values: mcpScopes,
+            variadic: true,
+            optional: true,
+          },
+        }
+        : {}),
+      "secret-key": {
+        kind: "parsed",
+        brief: "Sets the secretKey auth field for the API",
+        optional: true,
+        parse: (value) => {
+          return z.string().parse(value);
+        },
+      },
+      "server-url": {
+        kind: "parsed",
+        brief: "Overrides the default server URL used by the SDK",
+        optional: true,
+        parse: (value) => new URL(value).toString(),
+      },
+      "server-index": {
+        kind: "parsed",
+        brief: "Selects a predefined server used by the SDK",
+        optional: true,
+        parse: numberParser,
+      },
+      "log-level": {
+        kind: "enum",
+        brief: "The log level to use for the server",
+        default: "info",
+        values: consoleLoggerLevels,
+      },
+      env: {
+        kind: "parsed",
+        brief: "Environment variables made available to the server",
+        optional: true,
+        variadic: true,
+        parse: (val: string) => {
+          const sepIdx = val.indexOf("=");
+          if (sepIdx === -1) {
+            throw new Error("Invalid environment variable format");
+          }
+
+          const key = val.slice(0, sepIdx);
+          const value = val.slice(sepIdx + 1);
+
+          return [
+            z.string().nonempty({
+              message: "Environment variable key must be a non-empty string",
+            }).parse(key),
+            z.string().nonempty({
+              message: "Environment variable value must be a non-empty string",
+            }).parse(value),
+          ] satisfies [string, string];
+        },
+      },
+    },
+  },
+  docs: {
+    brief: "Run the Model Context Protocol server",
+  },
+});

package/src/mcp-server/cli/start/impl.ts

@@ -0,0 +1,131 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SSEServerTransport } from "@modelcontextprotocol/sdk/server/sse.js";
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import express from "express";
+import { SDKOptions } from "../../../lib/config.js";
+import { LocalContext } from "../../cli.js";
+import {
+  ConsoleLoggerLevel,
+  createConsoleLogger,
+} from "../../console-logger.js";
+import { MCPScope } from "../../scopes.js";
+import { createMCPServer } from "../../server.js";
+
+interface StartCommandFlags {
+  readonly transport: "stdio" | "sse";
+  readonly port: number;
+  readonly scope?: MCPScope[];
+  readonly "secret-key"?: string | undefined;
+  readonly "server-url"?: string;
+  readonly "server-index"?: SDKOptions["serverIdx"];
+  readonly "log-level": ConsoleLoggerLevel;
+  readonly env?: [string, string][];
+}
+
+export async function main(this: LocalContext, flags: StartCommandFlags) {
+  flags.env?.forEach(([key, value]) => {
+    process.env[key] = value;
+  });
+
+  switch (flags.transport) {
+    case "stdio":
+      await startStdio(flags);
+      break;
+    case "sse":
+      await startSSE(flags);
+      break;
+    default:
+      throw new Error(`Invalid transport: ${flags.transport}`);
+  }
+}
+
+async function startStdio(flags: StartCommandFlags) {
+  const logger = createConsoleLogger(flags["log-level"]);
+  const transport = new StdioServerTransport();
+  const server = createMCPServer({
+    logger,
+    scopes: flags.scope,
+    ...{ secretKey: flags["secret-key"] },
+    serverURL: flags["server-url"],
+    serverIdx: flags["server-index"],
+  });
+  await server.connect(transport);
+
+  const abort = async () => {
+    await server.close();
+    process.exit(0);
+  };
+  process.on("SIGTERM", abort);
+  process.on("SIGINT", abort);
+}
+
+async function startSSE(flags: StartCommandFlags) {
+  const logger = createConsoleLogger(flags["log-level"]);
+  const app = express();
+  const mcpServer = createMCPServer({
+    logger,
+    scopes: flags.scope,
+    ...{ secretKey: flags["secret-key"] },
+    serverURL: flags["server-url"],
+    serverIdx: flags["server-index"],
+  });
+  let transport: SSEServerTransport | undefined;
+  const controller = new AbortController();
+
+  app.get("/sse", async (_req, res) => {
+    transport = new SSEServerTransport("/message", res);
+
+    await mcpServer.connect(transport);
+
+    mcpServer.server.onclose = async () => {
+      res.end();
+    };
+  });
+
+  app.post("/message", async (req, res) => {
+    if (!transport) {
+      throw new Error("Server transport not initialized");
+    }
+
+    await transport.handlePostMessage(req, res);
+  });
+
+  const httpServer = app.listen(flags.port, "0.0.0.0", () => {
+    const ha = httpServer.address();
+    const host = typeof ha === "string" ? ha : `${ha?.address}:${ha?.port}`;
+    logger.info("MCP HTTP server started", { host });
+  });
+
+  let closing = false;
+  controller.signal.addEventListener("abort", async () => {
+    if (closing) {
+      logger.info("Received second signal. Forcing shutdown.");
+      process.exit(1);
+    }
+    closing = true;
+
+    logger.info("Shutting down MCP server");
+
+    await mcpServer.close();
+
+    logger.info("Shutting down HTTP server");
+
+    const timer = setTimeout(() => {
+      logger.info("Forcing shutdown");
+      process.exit(1);
+    }, 5000);
+
+    httpServer.close(() => {
+      clearTimeout(timer);
+      logger.info("Graceful shutdown complete");
+      process.exit(0);
+    });
+  });
+
+  const abort = () => controller.abort();
+  process.on("SIGTERM", abort);
+  process.on("SIGINT", abort);
+}

package/src/mcp-server/cli.ts

@@ -0,0 +1,13 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CommandContext, StricliProcess } from "@stricli/core";
+
+export interface LocalContext extends CommandContext {
+  readonly process: StricliProcess;
+}
+
+export function buildContext(process: NodeJS.Process): LocalContext {
+  return { process: process as StricliProcess };
+}