@sentry/junior-plugin-api 0.94.0 → 0.96.0

package/dist/index.js

@@ -261,7 +261,7 @@ function parsePluginToolInput(schema, args) {
   }
   return result.data;
 }
-function definePluginTool(definition) {
+function createZodTool(definition, helperName) {
   const { inputSchema, outputSchema, prepareArguments, execute, ...tool } = definition;
   let modelInputSchema;
   let modelOutputSchema;
@@ -269,7 +269,7 @@ function definePluginTool(definition) {
     modelInputSchema = z5.toJSONSchema(inputSchema);
   } catch (error) {
     throw new TypeError(
-      "definePluginTool() inputSchema must be representable as JSON Schema.",
+      `${helperName}() inputSchema must be representable as JSON Schema.`,
       { cause: error }
     );
   }
@@ -277,7 +277,7 @@ function definePluginTool(definition) {
     modelOutputSchema = z5.toJSONSchema(outputSchema);
   } catch (error) {
     throw new TypeError(
-      "definePluginTool() outputSchema must be representable as JSON Schema.",
+      `${helperName}() outputSchema must be representable as JSON Schema.`,
       { cause: error }
     );
   }
@@ -302,6 +302,12 @@ function definePluginTool(definition) {
     } : {}
   };
 }
+function zodTool(definition) {
+  return createZodTool(definition, "zodTool");
+}
+function definePluginTool(definition) {
+  return createZodTool(definition, "definePluginTool");
+}
 
 // src/operations.ts
 import { z as z6 } from "zod";
@@ -471,5 +477,6 @@ export {
   sourceSchema,
   sourceTypeSchema,
   subscribableResourceSchema,
-  systemActorSchema
+  systemActorSchema,
+  zodTool
 };

package/dist/tools.d.ts

@@ -113,6 +113,11 @@ export interface PluginToolDefinition<TInput = unknown, TOutput = unknown> {
     executionMode?: unknown;
     inputSchema: unknown;
     outputSchema?: unknown;
+    /**
+     * Select result fields that are safe to retain in private traces.
+     * Returning `undefined` suppresses private result capture.
+     */
+    privateTraceResult?(result: TOutput): unknown;
     prepareArguments?: (args: unknown) => unknown;
     /**
      * @deprecated Put tool-selection and usage guidance directly in `description`
@@ -134,9 +139,9 @@ type ZodPluginToolDefinition<TInputSchema extends ZodTypeAny, TOutputSchema exte
     prepareArguments?: (args: unknown) => z.input<TInputSchema>;
     execute?: (input: z.output<TInputSchema>, options: PluginToolExecuteOptions) => Promise<z.input<TOutputSchema>> | z.input<TOutputSchema>;
 };
-/**
- * Define a plugin tool with Zod input parsing and the structured result contract.
- */
+/** Define a plugin tool with Zod input parsing and validated structured results. */
+export declare function zodTool<TInputSchema extends ZodTypeAny, TOutputSchema extends ZodType<PluginToolResult>>(definition: ZodPluginToolDefinition<TInputSchema, TOutputSchema>): PluginToolDefinition<z.output<TInputSchema>, z.output<TOutputSchema>>;
+/** Define a plugin tool with Zod input parsing and the structured result contract. */
 export declare function definePluginTool<TInputSchema extends ZodTypeAny, TOutputSchema extends ZodType<PluginToolResult>>(definition: ZodPluginToolDefinition<TInputSchema, TOutputSchema>): PluginToolDefinition<z.output<TInputSchema>, z.output<TOutputSchema>>;
 export interface SlackToolRegistrationHookContext {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/junior-plugin-api",
-  "version": "0.94.0",
+  "version": "0.96.0",
   "private": false,
   "publishConfig": {
     "access": "public"

package/src/tools.ts

@@ -134,6 +134,11 @@ export interface PluginToolDefinition<TInput = unknown, TOutput = unknown> {
   executionMode?: unknown;
   inputSchema: unknown;
   outputSchema?: unknown;
+  /**
+   * Select result fields that are safe to retain in private traces.
+   * Returning `undefined` suppresses private result capture.
+   */
+  privateTraceResult?(result: TOutput): unknown;
   prepareArguments?: (args: unknown) => unknown;
   /**
    * @deprecated Put tool-selection and usage guidance directly in `description`
@@ -191,14 +196,12 @@ function parsePluginToolInput<TInputSchema extends ZodTypeAny>(
   return result.data;
 }
 
-/**
- * Define a plugin tool with Zod input parsing and the structured result contract.
- */
-export function definePluginTool<
+function createZodTool<
   TInputSchema extends ZodTypeAny,
   TOutputSchema extends ZodType<PluginToolResult>,
 >(
   definition: ZodPluginToolDefinition<TInputSchema, TOutputSchema>,
+  helperName: "definePluginTool" | "zodTool",
 ): PluginToolDefinition<z.output<TInputSchema>, z.output<TOutputSchema>> {
   const { inputSchema, outputSchema, prepareArguments, execute, ...tool } =
     definition;
@@ -208,7 +211,7 @@ export function definePluginTool<
     modelInputSchema = z.toJSONSchema(inputSchema);
   } catch (error) {
     throw new TypeError(
-      "definePluginTool() inputSchema must be representable as JSON Schema.",
+      `${helperName}() inputSchema must be representable as JSON Schema.`,
       { cause: error },
     );
   }
@@ -216,7 +219,7 @@ export function definePluginTool<
     modelOutputSchema = z.toJSONSchema(outputSchema);
   } catch (error) {
     throw new TypeError(
-      "definePluginTool() outputSchema must be representable as JSON Schema.",
+      `${helperName}() outputSchema must be representable as JSON Schema.`,
       { cause: error },
     );
   }
@@ -244,6 +247,26 @@ export function definePluginTool<
   };
 }
 
+/** Define a plugin tool with Zod input parsing and validated structured results. */
+export function zodTool<
+  TInputSchema extends ZodTypeAny,
+  TOutputSchema extends ZodType<PluginToolResult>,
+>(
+  definition: ZodPluginToolDefinition<TInputSchema, TOutputSchema>,
+): PluginToolDefinition<z.output<TInputSchema>, z.output<TOutputSchema>> {
+  return createZodTool(definition, "zodTool");
+}
+
+/** Define a plugin tool with Zod input parsing and the structured result contract. */
+export function definePluginTool<
+  TInputSchema extends ZodTypeAny,
+  TOutputSchema extends ZodType<PluginToolResult>,
+>(
+  definition: ZodPluginToolDefinition<TInputSchema, TOutputSchema>,
+): PluginToolDefinition<z.output<TInputSchema>, z.output<TOutputSchema>> {
+  return createZodTool(definition, "definePluginTool");
+}
+
 export interface SlackToolRegistrationHookContext {
   /**
    * Capabilities of the source Slack conversation exposed to this plugin.