@hookdeck/outpost-sdk 0.9.1 → 0.10.0

package/src/lib/url.ts

@@ -13,21 +13,23 @@ export function pathToFunc(
   const paramRE = /\{([a-zA-Z0-9_][a-zA-Z0-9_-]*?)\}/g;
 
   return function buildURLPath(params: Record<string, unknown> = {}): string {
-    return pathPattern.replace(paramRE, function (_, placeholder) {
-      if (!hasOwn.call(params, placeholder)) {
-        throw new Error(`Parameter '${placeholder}' is required`);
-      }
+    return pathPattern
+      .replace(paramRE, function (_, placeholder) {
+        if (!hasOwn.call(params, placeholder)) {
+          throw new Error(`Parameter '${placeholder}' is required`);
+        }
 
-      const value = params[placeholder];
-      if (typeof value !== "string" && typeof value !== "number") {
-        throw new Error(
-          `Parameter '${placeholder}' must be a string or number`,
-        );
-      }
+        const value = params[placeholder];
+        if (typeof value !== "string" && typeof value !== "number") {
+          throw new Error(
+            `Parameter '${placeholder}' must be a string or number`,
+          );
+        }
 
-      return options?.charEncoding === "percent"
-        ? encodeURIComponent(`${value}`)
-        : `${value}`;
-    });
+        return options?.charEncoding === "percent"
+          ? encodeURIComponent(`${value}`)
+          : `${value}`;
+      })
+      .replace(/^\/+/, "");
   };
 }

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

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

package/src/mcp-server/server.ts

@@ -28,6 +28,8 @@ import { tool$destinationsUpdate } from "./tools/destinationsUpdate.js";
 import { tool$eventsGet } from "./tools/eventsGet.js";
 import { tool$eventsList } from "./tools/eventsList.js";
 import { tool$healthCheck } from "./tools/healthCheck.js";
+import { tool$metricsGetAttemptMetrics } from "./tools/metricsGetAttemptMetrics.js";
+import { tool$metricsGetEventMetrics } from "./tools/metricsGetEventMetrics.js";
 import { tool$publishEvent } from "./tools/publishEvent.js";
 import { tool$schemasGetDestinationType } from "./tools/schemasGetDestinationType.js";
 import { tool$schemasListDestinationTypes } from "./tools/schemasListDestinationTypes.js";
@@ -49,7 +51,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "Outpost",
-    version: "0.9.1",
+    version: "0.10.0",
   });
 
   const client = new OutpostCore({
@@ -104,6 +106,8 @@ export function createMCPServer(deps: {
   tool(tool$schemasListDestinationTypes);
   tool(tool$schemasGetDestinationType);
   tool(tool$topicsList);
+  tool(tool$metricsGetEventMetrics);
+  tool(tool$metricsGetAttemptMetrics);
 
   return server;
 }

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

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { metricsGetAttemptMetrics } from "../../funcs/metricsGetAttemptMetrics.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetAttemptMetricsRequest$inboundSchema,
+};
+
+export const tool$metricsGetAttemptMetrics: ToolDefinition<typeof args> = {
+  name: "metrics-get-attempt-metrics",
+  description: `Get Attempt Metrics
+
+Returns aggregated delivery attempt metrics. Supports time bucketing via granularity,
+dimensional grouping, and filtering.
+
+**Measures:** \`count\`, \`successful_count\`, \`failed_count\`, \`error_rate\`,
+\`first_attempt_count\`, \`retry_count\`, \`manual_retry_count\`, \`avg_attempt_number\`,
+\`rate\`, \`successful_rate\`, \`failed_rate\`
+
+**Dimensions:** \`tenant_id\` (admin-only), \`destination_id\`, \`topic\`, \`status\`, \`code\`, \`manual\`, \`attempt_number\`
+
+**Filters:** \`tenant_id\` (admin-only), \`destination_id\`, \`topic\`, \`status\`, \`code\`, \`manual\`, \`attempt_number\`
+`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await metricsGetAttemptMetrics(
+      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/metricsGetEventMetrics.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { metricsGetEventMetrics } from "../../funcs/metricsGetEventMetrics.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetEventMetricsRequest$inboundSchema,
+};
+
+export const tool$metricsGetEventMetrics: ToolDefinition<typeof args> = {
+  name: "metrics-get-event-metrics",
+  description: `Get Event Metrics
+
+Returns aggregated event publish metrics. Supports time bucketing via granularity,
+dimensional grouping, and filtering.
+
+**Measures:** \`count\`, \`rate\`
+
+**Dimensions:** \`tenant_id\` (admin-only), \`topic\`, \`destination_id\`
+
+**Filters:** \`tenant_id\` (admin-only), \`topic\`, \`destination_id\`
+`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await metricsGetEventMetrics(
+      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/models/components/attempt.ts

@@ -9,17 +9,11 @@ import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
-  EventFull,
-  EventFull$inboundSchema,
-  EventFull$Outbound,
-  EventFull$outboundSchema,
-} from "./eventfull.js";
-import {
-  EventSummary,
-  EventSummary$inboundSchema,
-  EventSummary$Outbound,
-  EventSummary$outboundSchema,
-} from "./eventsummary.js";
+  Destination,
+  Destination$inboundSchema,
+  Destination$Outbound,
+  Destination$outboundSchema,
+} from "./destination.js";
 
 /**
  * The attempt status.
@@ -33,6 +27,60 @@ export const Status = {
  */
 export type Status = ClosedEnum<typeof Status>;
 
+/**
+ * Full event object with data (returned when include=event.data).
+ */
+export type EventFull = {
+  id?: string | undefined;
+  /**
+   * The tenant this event belongs to.
+   */
+  tenantId?: string | undefined;
+  /**
+   * The destination this event was delivered to.
+   */
+  destinationId?: string | undefined;
+  topic?: string | undefined;
+  /**
+   * Time the event was received.
+   */
+  time?: Date | undefined;
+  /**
+   * Whether this event can be retried.
+   */
+  eligibleForRetry?: boolean | undefined;
+  metadata?: { [k: string]: string } | null | undefined;
+  /**
+   * The event payload data.
+   */
+  data?: { [k: string]: any } | undefined;
+};
+
+/**
+ * Event object without data (returned when include=event).
+ */
+export type EventSummary = {
+  id?: string | undefined;
+  /**
+   * The tenant this event belongs to.
+   */
+  tenantId?: string | undefined;
+  /**
+   * The destination this event was delivered to.
+   */
+  destinationId?: string | undefined;
+  topic?: string | undefined;
+  /**
+   * Time the event was received.
+   */
+  time?: Date | undefined;
+  /**
+   * Whether this event can be retried.
+   */
+  eligibleForRetry?: boolean | undefined;
+  metadata?: { [k: string]: string } | null | undefined;
+};
+
 /**
  * The associated event object. Only present when include=event or include=event.data.
  */
@@ -65,7 +113,7 @@ export type Attempt = {
   /**
    * Response data from the attempt. Only included when include=response_data.
    */
-  responseData?: { [k: string]: any } | undefined;
+  responseData?: { [k: string]: any } | null | undefined;
   /**
    * The attempt number (1 for first attempt, 2+ for retries).
    */
@@ -85,7 +133,8 @@ export type Attempt = {
   /**
    * The associated event object. Only present when include=event or include=event.data.
    */
-  event?: EventSummary | EventFull | undefined;
+  event?: EventSummary | EventFull | null | undefined;
+  destination?: Destination | undefined;
 };
 
 /** @internal */
@@ -95,12 +144,150 @@ export const Status$inboundSchema: z.ZodNativeEnum<typeof Status> = z
 export const Status$outboundSchema: z.ZodNativeEnum<typeof Status> =
   Status$inboundSchema;
 
+/** @internal */
+export const EventFull$inboundSchema: z.ZodType<
+  EventFull,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  tenant_id: z.string().optional(),
+  destination_id: z.string().optional(),
+  topic: z.string().optional(),
+  time: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  eligible_for_retry: z.boolean().optional(),
+  metadata: z.nullable(z.record(z.string())).optional(),
+  data: z.record(z.any()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "tenant_id": "tenantId",
+    "destination_id": "destinationId",
+    "eligible_for_retry": "eligibleForRetry",
+  });
+});
+/** @internal */
+export type EventFull$Outbound = {
+  id?: string | undefined;
+  tenant_id?: string | undefined;
+  destination_id?: string | undefined;
+  topic?: string | undefined;
+  time?: string | undefined;
+  eligible_for_retry?: boolean | undefined;
+  metadata?: { [k: string]: string } | null | undefined;
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const EventFull$outboundSchema: z.ZodType<
+  EventFull$Outbound,
+  z.ZodTypeDef,
+  EventFull
+> = z.object({
+  id: z.string().optional(),
+  tenantId: z.string().optional(),
+  destinationId: z.string().optional(),
+  topic: z.string().optional(),
+  time: z.date().transform(v => v.toISOString()).optional(),
+  eligibleForRetry: z.boolean().optional(),
+  metadata: z.nullable(z.record(z.string())).optional(),
+  data: z.record(z.any()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    tenantId: "tenant_id",
+    destinationId: "destination_id",
+    eligibleForRetry: "eligible_for_retry",
+  });
+});
+
+export function eventFullToJSON(eventFull: EventFull): string {
+  return JSON.stringify(EventFull$outboundSchema.parse(eventFull));
+}
+export function eventFullFromJSON(
+  jsonString: string,
+): SafeParseResult<EventFull, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventFull$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventFull' from JSON`,
+  );
+}
+
+/** @internal */
+export const EventSummary$inboundSchema: z.ZodType<
+  EventSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  tenant_id: z.string().optional(),
+  destination_id: z.string().optional(),
+  topic: z.string().optional(),
+  time: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  eligible_for_retry: z.boolean().optional(),
+  metadata: z.nullable(z.record(z.string())).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "tenant_id": "tenantId",
+    "destination_id": "destinationId",
+    "eligible_for_retry": "eligibleForRetry",
+  });
+});
+/** @internal */
+export type EventSummary$Outbound = {
+  id?: string | undefined;
+  tenant_id?: string | undefined;
+  destination_id?: string | undefined;
+  topic?: string | undefined;
+  time?: string | undefined;
+  eligible_for_retry?: boolean | undefined;
+  metadata?: { [k: string]: string } | null | undefined;
+};
+
+/** @internal */
+export const EventSummary$outboundSchema: z.ZodType<
+  EventSummary$Outbound,
+  z.ZodTypeDef,
+  EventSummary
+> = z.object({
+  id: z.string().optional(),
+  tenantId: z.string().optional(),
+  destinationId: z.string().optional(),
+  topic: z.string().optional(),
+  time: z.date().transform(v => v.toISOString()).optional(),
+  eligibleForRetry: z.boolean().optional(),
+  metadata: z.nullable(z.record(z.string())).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    tenantId: "tenant_id",
+    destinationId: "destination_id",
+    eligibleForRetry: "eligible_for_retry",
+  });
+});
+
+export function eventSummaryToJSON(eventSummary: EventSummary): string {
+  return JSON.stringify(EventSummary$outboundSchema.parse(eventSummary));
+}
+export function eventSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<EventSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventSummary' from JSON`,
+  );
+}
+
 /** @internal */
 export const EventUnion$inboundSchema: z.ZodType<
   EventUnion,
   z.ZodTypeDef,
   unknown
-> = z.union([EventSummary$inboundSchema, EventFull$inboundSchema]);
+> = z.union([
+  z.lazy(() => EventSummary$inboundSchema),
+  z.lazy(() => EventFull$inboundSchema),
+]);
 /** @internal */
 export type EventUnion$Outbound = EventSummary$Outbound | EventFull$Outbound;
 
@@ -109,7 +296,10 @@ export const EventUnion$outboundSchema: z.ZodType<
   EventUnion$Outbound,
   z.ZodTypeDef,
   EventUnion
-> = z.union([EventSummary$outboundSchema, EventFull$outboundSchema]);
+> = z.union([
+  z.lazy(() => EventSummary$outboundSchema),
+  z.lazy(() => EventFull$outboundSchema),
+]);
 
 export function eventUnionToJSON(eventUnion: EventUnion): string {
   return JSON.stringify(EventUnion$outboundSchema.parse(eventUnion));
@@ -133,13 +323,18 @@ export const Attempt$inboundSchema: z.ZodType<Attempt, z.ZodTypeDef, unknown> =
     time: z.string().datetime({ offset: true }).transform(v => new Date(v))
       .optional(),
     code: z.string().optional(),
-    response_data: z.record(z.any()).optional(),
+    response_data: z.nullable(z.record(z.any())).optional(),
     attempt_number: z.number().int().optional(),
     manual: z.boolean().optional(),
     event_id: z.string().optional(),
     destination_id: z.string().optional(),
-    event: z.union([EventSummary$inboundSchema, EventFull$inboundSchema])
-      .optional(),
+    event: z.nullable(
+      z.union([
+        z.lazy(() => EventSummary$inboundSchema),
+        z.lazy(() => EventFull$inboundSchema),
+      ]),
+    ).optional(),
+    destination: Destination$inboundSchema.optional(),
   }).transform((v) => {
     return remap$(v, {
       "tenant_id": "tenantId",
@@ -156,12 +351,13 @@ export type Attempt$Outbound = {
   status?: string | undefined;
   time?: string | undefined;
   code?: string | undefined;
-  response_data?: { [k: string]: any } | undefined;
+  response_data?: { [k: string]: any } | null | undefined;
   attempt_number?: number | undefined;
   manual?: boolean | undefined;
   event_id?: string | undefined;
   destination_id?: string | undefined;
-  event?: EventSummary$Outbound | EventFull$Outbound | undefined;
+  event?: EventSummary$Outbound | EventFull$Outbound | null | undefined;
+  destination?: Destination$Outbound | undefined;
 };
 
 /** @internal */
@@ -175,13 +371,18 @@ export const Attempt$outboundSchema: z.ZodType<
   status: Status$outboundSchema.optional(),
   time: z.date().transform(v => v.toISOString()).optional(),
   code: z.string().optional(),
-  responseData: z.record(z.any()).optional(),
+  responseData: z.nullable(z.record(z.any())).optional(),
   attemptNumber: z.number().int().optional(),
   manual: z.boolean().optional(),
   eventId: z.string().optional(),
   destinationId: z.string().optional(),
-  event: z.union([EventSummary$outboundSchema, EventFull$outboundSchema])
-    .optional(),
+  event: z.nullable(
+    z.union([
+      z.lazy(() => EventSummary$outboundSchema),
+      z.lazy(() => EventFull$outboundSchema),
+    ]),
+  ).optional(),
+  destination: Destination$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     tenantId: "tenant_id",

package/src/models/components/destinationschemafield.ts

@@ -12,10 +12,20 @@ export const TypeEnum = {
   Text: "text",
   Checkbox: "checkbox",
   KeyValueMap: "key_value_map",
+  Select: "select",
 } as const;
 export type TypeEnum = ClosedEnum<typeof TypeEnum>;
 
+export type Option = {
+  label: string;
+  value: string;
+};
+
 export type DestinationSchemaField = {
+  /**
+   * The config key used to store and retrieve the field value. Matches the key in the destination's config or credentials object.
+   */
+  key: string;
   type: TypeEnum;
   label?: string | undefined;
   description?: string | undefined;
@@ -40,6 +50,10 @@ export type DestinationSchemaField = {
    * Regex pattern for validation (compatible with HTML5 pattern attribute).
    */
   pattern?: string | undefined;
+  /**
+   * Available options for select fields.
+   */
+  options?: Array<Option> | undefined;
 };
 
 /** @internal */
@@ -49,12 +63,48 @@ export const TypeEnum$inboundSchema: z.ZodNativeEnum<typeof TypeEnum> = z
 export const TypeEnum$outboundSchema: z.ZodNativeEnum<typeof TypeEnum> =
   TypeEnum$inboundSchema;
 
+/** @internal */
+export const Option$inboundSchema: z.ZodType<Option, z.ZodTypeDef, unknown> = z
+  .object({
+    label: z.string(),
+    value: z.string(),
+  });
+/** @internal */
+export type Option$Outbound = {
+  label: string;
+  value: string;
+};
+
+/** @internal */
+export const Option$outboundSchema: z.ZodType<
+  Option$Outbound,
+  z.ZodTypeDef,
+  Option
+> = z.object({
+  label: z.string(),
+  value: z.string(),
+});
+
+export function optionToJSON(option: Option): string {
+  return JSON.stringify(Option$outboundSchema.parse(option));
+}
+export function optionFromJSON(
+  jsonString: string,
+): SafeParseResult<Option, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Option$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Option' from JSON`,
+  );
+}
+
 /** @internal */
 export const DestinationSchemaField$inboundSchema: z.ZodType<
   DestinationSchemaField,
   z.ZodTypeDef,
   unknown
 > = z.object({
+  key: z.string(),
   type: TypeEnum$inboundSchema,
   label: z.string().optional(),
   description: z.string().optional(),
@@ -64,9 +114,11 @@ export const DestinationSchemaField$inboundSchema: z.ZodType<
   minlength: z.number().int().optional(),
   maxlength: z.number().int().optional(),
   pattern: z.string().optional(),
+  options: z.array(z.lazy(() => Option$inboundSchema)).optional(),
 });
 /** @internal */
 export type DestinationSchemaField$Outbound = {
+  key: string;
   type: string;
   label?: string | undefined;
   description?: string | undefined;
@@ -76,6 +128,7 @@ export type DestinationSchemaField$Outbound = {
   minlength?: number | undefined;
   maxlength?: number | undefined;
   pattern?: string | undefined;
+  options?: Array<Option$Outbound> | undefined;
 };
 
 /** @internal */
@@ -84,6 +137,7 @@ export const DestinationSchemaField$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   DestinationSchemaField
 > = z.object({
+  key: z.string(),
   type: TypeEnum$outboundSchema,
   label: z.string().optional(),
   description: z.string().optional(),
@@ -93,6 +147,7 @@ export const DestinationSchemaField$outboundSchema: z.ZodType<
   minlength: z.number().int().optional(),
   maxlength: z.number().int().optional(),
   pattern: z.string().optional(),
+  options: z.array(z.lazy(() => Option$outboundSchema)).optional(),
 });
 
 export function destinationSchemaFieldToJSON(

package/src/models/components/event.ts

@@ -14,7 +14,10 @@ export type Event = {
    * The tenant this event belongs to.
    */
   tenantId?: string | undefined;
-  destinationId?: string | undefined;
+  /**
+   * The destination IDs that this event was routed to based on topic and filter matching.
+   */
+  matchedDestinationIds?: Array<string> | undefined;
   topic?: string | undefined;
   /**
    * Time the event was received/processed.
@@ -35,7 +38,7 @@ export const Event$inboundSchema: z.ZodType<Event, z.ZodTypeDef, unknown> = z
   .object({
     id: z.string().optional(),
     tenant_id: z.string().optional(),
-    destination_id: z.string().optional(),
+    matched_destination_ids: z.array(z.string()).optional(),
     topic: z.string().optional(),
     time: z.string().datetime({ offset: true }).transform(v => new Date(v))
       .optional(),
@@ -44,14 +47,14 @@ export const Event$inboundSchema: z.ZodType<Event, z.ZodTypeDef, unknown> = z
   }).transform((v) => {
     return remap$(v, {
       "tenant_id": "tenantId",
-      "destination_id": "destinationId",
+      "matched_destination_ids": "matchedDestinationIds",
     });
   });
 /** @internal */
 export type Event$Outbound = {
   id?: string | undefined;
   tenant_id?: string | undefined;
-  destination_id?: string | undefined;
+  matched_destination_ids?: Array<string> | undefined;
   topic?: string | undefined;
   time?: string | undefined;
   metadata?: { [k: string]: string } | null | undefined;
@@ -66,7 +69,7 @@ export const Event$outboundSchema: z.ZodType<
 > = z.object({
   id: z.string().optional(),
   tenantId: z.string().optional(),
-  destinationId: z.string().optional(),
+  matchedDestinationIds: z.array(z.string()).optional(),
   topic: z.string().optional(),
   time: z.date().transform(v => v.toISOString()).optional(),
   metadata: z.nullable(z.record(z.string())).optional(),
@@ -74,7 +77,7 @@ export const Event$outboundSchema: z.ZodType<
 }).transform((v) => {
   return remap$(v, {
     tenantId: "tenant_id",
-    destinationId: "destination_id",
+    matchedDestinationIds: "matched_destination_ids",
   });
 });
 

package/src/models/components/index.ts

@@ -43,12 +43,13 @@ export * from "./destinationupdaterabbitmq.js";
 export * from "./destinationupdatewebhook.js";
 export * from "./destinationwebhook.js";
 export * from "./event.js";
-export * from "./eventfull.js";
 export * from "./eventpaginatedresult.js";
-export * from "./eventsummary.js";
 export * from "./gcppubsubconfig.js";
 export * from "./gcppubsubcredentials.js";
 export * from "./hookdeckcredentials.js";
+export * from "./metricsdatapoint.js";
+export * from "./metricsmetadata.js";
+export * from "./metricsresponse.js";
 export * from "./portalredirect.js";
 export * from "./publishrequest.js";
 export * from "./publishresponse.js";