@hookdeck/outpost-sdk 0.0.2

package/src/mcp-server/server.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { OutpostCore } 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 } from "./scopes.js";
+import { createRegisterTool } from "./tools.js";
+import { tool$healthCheck } from "./tools/healthCheck.js";
+import { tool$publishEvent } from "./tools/publishEvent.js";
+import { tool$tenantsGetPortalUrl } from "./tools/tenantsGetPortalUrl.js";
+import { tool$tenantsGetPortalUrlJwtContext } from "./tools/tenantsGetPortalUrlJwtContext.js";
+import { tool$tenantsGetToken } from "./tools/tenantsGetToken.js";
+import { tool$tenantsGetTokenJwtContext } from "./tools/tenantsGetTokenJwtContext.js";
+import { tool$tenantsUpsert } from "./tools/tenantsUpsert.js";
+
+export function createMCPServer(deps: {
+  logger: ConsoleLogger;
+  allowedTools?: string[] | undefined;
+  scopes?: MCPScope[] | undefined;
+  serverURL?: string | undefined;
+  adminApiKey?: SDKOptions["adminApiKey"] | undefined;
+  tenantId?: SDKOptions["tenantId"] | undefined;
+  serverIdx?: SDKOptions["serverIdx"] | undefined;
+}) {
+  const server = new McpServer({
+    name: "Outpost",
+    version: "0.0.2",
+  });
+
+  const client = new OutpostCore({
+    adminApiKey: deps.adminApiKey,
+    tenantId: deps.tenantId,
+    serverURL: deps.serverURL,
+    serverIdx: deps.serverIdx,
+  });
+
+  const scopes = new Set(deps.scopes);
+
+  const allowedTools = deps.allowedTools && new Set(deps.allowedTools);
+  const tool = createRegisterTool(
+    deps.logger,
+    server,
+    client,
+    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$healthCheck);
+  tool(tool$tenantsUpsert);
+  tool(tool$tenantsGetPortalUrl);
+  tool(tool$tenantsGetToken);
+  tool(tool$tenantsGetPortalUrlJwtContext);
+  tool(tool$tenantsGetTokenJwtContext);
+  tool(tool$publishEvent);
+
+  return server;
+}

package/src/mcp-server/shared.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { bytesToBase64 } from "../lib/base64.js";
+
+type BinaryData =
+  | Uint8Array
+  | ArrayBuffer
+  | Blob
+  | ReadableStream
+  | Response
+  | string;
+
+export async function consumeStream(
+  stream: ReadableStream<Uint8Array>,
+): Promise<Uint8Array> {
+  const reader = stream.getReader();
+  const chunks: Uint8Array[] = [];
+
+  try {
+    while (true) {
+      const { done, value } = await reader.read();
+      if (value != null) chunks.push(value);
+      if (done) break;
+    }
+  } finally {
+    reader.releaseLock();
+  }
+
+  return new Uint8Array(await new Blob(chunks).arrayBuffer());
+}
+
+export function isAsyncIterable(
+  value: unknown,
+): value is AsyncIterable<string> {
+  return (
+    typeof value === "object" && value != null && Symbol.asyncIterator in value
+  );
+}
+
+export function isBinaryData(value: unknown): value is BinaryData {
+  return (
+    value instanceof Uint8Array
+    || value instanceof ArrayBuffer
+    || value instanceof Blob
+    || value instanceof ReadableStream
+    || value instanceof Response
+    || typeof value === "string"
+  );
+}
+
+const base64Schema = z.string().base64();
+
+export async function valueToBase64(
+  value: BinaryData | null | undefined,
+): Promise<string | null> {
+  if (value == null) {
+    return null;
+  } else if (value instanceof Uint8Array) {
+    return bytesToBase64(value);
+  } else if (value instanceof ArrayBuffer) {
+    return bytesToBase64(new Uint8Array(value));
+  } else if (value instanceof Response || value instanceof Blob) {
+    return bytesToBase64(new Uint8Array(await value.arrayBuffer()));
+  } else if (value instanceof ReadableStream) {
+    return bytesToBase64(await consumeStream(value));
+  } else if (typeof value === "string") {
+    return base64Schema.parse(value);
+  } else {
+    value satisfies never;
+    throw new Error(`Unsupported image value type: ${typeof value}`);
+  }
+}

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

@@ -0,0 +1,30 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { healthCheck } from "../../funcs/healthCheck.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+export const tool$healthCheck: ToolDefinition = {
+  name: "health-check",
+  description: `Health Check
+
+Simple health check endpoint.`,
+  tool: async (client, ctx) => {
+    const [result, apiCall] = await healthCheck(
+      client,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

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

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { publishEvent } from "../../funcs/publishEvent.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: components.PublishRequest$inboundSchema,
+};
+
+export const tool$publishEvent: ToolDefinition<typeof args> = {
+  name: "publish-event",
+  description: `Publish Event
+
+Publishes an event to the specified topic, potentially routed to a specific destination. Requires Admin API Key.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await publishEvent(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    return formatResult(void 0, apiCall);
+  },
+};

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

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { tenantsGetPortalUrl } from "../../funcs/tenantsGetPortalUrl.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetTenantPortalUrlRequest$inboundSchema,
+};
+
+export const tool$tenantsGetPortalUrl: ToolDefinition<typeof args> = {
+  name: "tenants-get-portal-url",
+  description: `Get Portal Redirect URL
+
+Returns a redirect URL containing a JWT to authenticate the user with the portal.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await tenantsGetPortalUrl(
+      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;
+
+    return formatResult(value, apiCall);
+  },
+};

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

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { tenantsGetPortalUrlJwtContext } from "../../funcs/tenantsGetPortalUrlJwtContext.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetPortalUrlJwtContextRequest$inboundSchema,
+};
+
+export const tool$tenantsGetPortalUrlJwtContext: ToolDefinition<typeof args> = {
+  name: "tenants-get-portal-url-jwt-context",
+  description: `Get Portal Redirect URL (JWT Auth Context)
+
+Returns a redirect URL containing a JWT to authenticate the user with the portal (infers tenant from JWT). Requires Admin API Key.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await tenantsGetPortalUrlJwtContext(
+      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;
+
+    return formatResult(value, apiCall);
+  },
+};

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

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { tenantsGetToken } from "../../funcs/tenantsGetToken.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetTenantTokenRequest$inboundSchema,
+};
+
+export const tool$tenantsGetToken: ToolDefinition<typeof args> = {
+  name: "tenants-get-token",
+  description: `Get Tenant JWT Token
+
+Returns a JWT token scoped to the tenant for safe browser API calls.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await tenantsGetToken(
+      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;
+
+    return formatResult(value, apiCall);
+  },
+};

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

@@ -0,0 +1,30 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { tenantsGetTokenJwtContext } from "../../funcs/tenantsGetTokenJwtContext.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+export const tool$tenantsGetTokenJwtContext: ToolDefinition = {
+  name: "tenants-get-token-jwt-context",
+  description: `Get Tenant JWT Token (JWT Auth Context)
+
+Returns a JWT token scoped to the tenant (infers tenant from JWT). Requires Admin API Key.`,
+  tool: async (client, ctx) => {
+    const [result, apiCall] = await tenantsGetTokenJwtContext(
+      client,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

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

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { tenantsUpsert } from "../../funcs/tenantsUpsert.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.UpsertTenantRequest$inboundSchema,
+};
+
+export const tool$tenantsUpsert: ToolDefinition<typeof args> = {
+  name: "tenants-upsert",
+  description: `Create or Update Tenant
+
+Idempotently creates or updates a tenant. Required before associating destinations.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await tenantsUpsert(
+      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;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools.ts

@@ -0,0 +1,129 @@
+/*
+ * 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 { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { objectOutputType, ZodRawShape, ZodTypeAny } from "zod";
+import { OutpostCore } from "../core.js";
+import { ConsoleLogger } from "./console-logger.js";
+import { MCPScope } from "./scopes.js";
+import { isAsyncIterable, isBinaryData, valueToBase64 } from "./shared.js";
+
+export type ToolDefinition<Args extends undefined | ZodRawShape = undefined> =
+  Args extends ZodRawShape ? {
+      name: string;
+      description: string;
+      scopes?: MCPScope[];
+      args: Args;
+      tool: (
+        client: OutpostCore,
+        args: objectOutputType<Args, ZodTypeAny>,
+        extra: RequestHandlerExtra,
+      ) => CallToolResult | Promise<CallToolResult>;
+    }
+    : {
+      name: string;
+      description: string;
+      scopes?: MCPScope[];
+      args?: undefined;
+      tool: (
+        client: OutpostCore,
+        extra: RequestHandlerExtra,
+      ) => CallToolResult | Promise<CallToolResult>;
+    };
+
+// Optional function to assist with formatting tool results
+export async function formatResult(
+  value: unknown,
+  init: { response?: Response | undefined },
+): Promise<CallToolResult> {
+  if (typeof value === "undefined") {
+    return { content: [] };
+  }
+
+  const { response } = init;
+  const contentType = response?.headers.get("content-type") ?? "";
+  let content: CallToolResult["content"] = [];
+
+  if (contentType.search(/\bjson\b/g)) {
+    content = [{ type: "text", text: JSON.stringify(value) }];
+  } else if (
+    contentType.startsWith("text/event-stream")
+    && isAsyncIterable(value)
+  ) {
+    content = await consumeSSE(value);
+  } else if (contentType.startsWith("text/") && typeof value === "string") {
+    content = [{ type: "text", text: value }];
+  } else if (isBinaryData(value) && contentType.startsWith("image/")) {
+    const data = await valueToBase64(value);
+    content = data == null
+      ? []
+      : [{ type: "image", data, mimeType: contentType }];
+  } else {
+    return {
+      content: [{
+        type: "text",
+        text: `Unsupported content type: "${contentType}"`,
+      }],
+      isError: true,
+    };
+  }
+
+  return { content };
+}
+
+async function consumeSSE(
+  value: AsyncIterable<unknown>,
+): Promise<CallToolResult["content"]> {
+  const content: CallToolResult["content"] = [];
+
+  for await (const chunk of value) {
+    if (typeof chunk === "string") {
+      content.push({ type: "text", text: chunk });
+    } else {
+      content.push({ type: "text", text: JSON.stringify(chunk) });
+    }
+  }
+
+  return content;
+}
+
+export function createRegisterTool(
+  logger: ConsoleLogger,
+  server: McpServer,
+  sdk: OutpostCore,
+  allowedScopes: Set<MCPScope>,
+  allowedTools?: Set<string>,
+): <A extends ZodRawShape | undefined>(tool: ToolDefinition<A>) => void {
+  return <A extends ZodRawShape | undefined>(tool: ToolDefinition<A>): void => {
+    if (allowedTools && !allowedTools.has(tool.name)) {
+      return;
+    }
+
+    const scopes = tool.scopes ?? [];
+    if (allowedScopes.size > 0 && scopes.length === 0) {
+      return;
+    }
+
+    if (
+      allowedScopes.size > 0
+      && !scopes.every((s: MCPScope) => allowedScopes.has(s))
+    ) {
+      return;
+    }
+
+    if (tool.args) {
+      server.tool(tool.name, tool.description, tool.args, async (args, ctx) => {
+        return tool.tool(sdk, args, ctx);
+      });
+    } else {
+      server.tool(tool.name, tool.description, async (ctx) => {
+        return tool.tool(sdk, ctx);
+      });
+    }
+
+    logger.debug("Registered tool", { name: tool.name });
+  };
+}

package/src/models/components/awskinesisconfig.ts

@@ -0,0 +1,101 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AWSKinesisConfig = {
+  /**
+   * The name of the AWS Kinesis stream.
+   */
+  streamName: string;
+  /**
+   * The AWS region where the Kinesis stream is located.
+   */
+  region: string;
+  /**
+   * Optional. Custom AWS endpoint URL (e.g., for LocalStack or VPC endpoints).
+   */
+  endpoint?: string | undefined;
+  /**
+   * Optional. JMESPath template to extract the partition key from the event payload (e.g., `metadata."event-id"`). Defaults to event ID.
+   */
+  partitionKeyTemplate?: string | undefined;
+};
+
+/** @internal */
+export const AWSKinesisConfig$inboundSchema: z.ZodType<
+  AWSKinesisConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  stream_name: z.string(),
+  region: z.string(),
+  endpoint: z.string().optional(),
+  partition_key_template: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "stream_name": "streamName",
+    "partition_key_template": "partitionKeyTemplate",
+  });
+});
+
+/** @internal */
+export type AWSKinesisConfig$Outbound = {
+  stream_name: string;
+  region: string;
+  endpoint?: string | undefined;
+  partition_key_template?: string | undefined;
+};
+
+/** @internal */
+export const AWSKinesisConfig$outboundSchema: z.ZodType<
+  AWSKinesisConfig$Outbound,
+  z.ZodTypeDef,
+  AWSKinesisConfig
+> = z.object({
+  streamName: z.string(),
+  region: z.string(),
+  endpoint: z.string().optional(),
+  partitionKeyTemplate: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    streamName: "stream_name",
+    partitionKeyTemplate: "partition_key_template",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AWSKinesisConfig$ {
+  /** @deprecated use `AWSKinesisConfig$inboundSchema` instead. */
+  export const inboundSchema = AWSKinesisConfig$inboundSchema;
+  /** @deprecated use `AWSKinesisConfig$outboundSchema` instead. */
+  export const outboundSchema = AWSKinesisConfig$outboundSchema;
+  /** @deprecated use `AWSKinesisConfig$Outbound` instead. */
+  export type Outbound = AWSKinesisConfig$Outbound;
+}
+
+export function awsKinesisConfigToJSON(
+  awsKinesisConfig: AWSKinesisConfig,
+): string {
+  return JSON.stringify(
+    AWSKinesisConfig$outboundSchema.parse(awsKinesisConfig),
+  );
+}
+
+export function awsKinesisConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<AWSKinesisConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AWSKinesisConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AWSKinesisConfig' from JSON`,
+  );
+}