@sentry/junior-plugin-api 0.116.0 → 0.117.0

package/dist/hooks.d.ts

@@ -1,10 +1,10 @@
 import type { EgressHookContext, EgressResponseHookContext, IssueCredentialHookContext, PluginCredentialResult, PluginGrant, PluginProviderAccount, ResolveOAuthAccountHookContext } from "./credentials";
 import type { HeartbeatHookContext, HeartbeatResult, OperationalReportHookContext, ApiRouteRegistrationHookContext, PluginOperationalReportContent, PluginRoute, PluginRouteApp, RouteRegistrationHookContext, SlackConversationLink, SlackConversationLinkHookContext } from "./operations";
 import type { BeforeToolExecuteHookContext, PluginToolDefinition, SandboxPrepareHookContext, ToolRegistrationHookContext } from "./tools";
-import type { PromptMessage, SystemPromptContext, UserPromptContext } from "./prompt";
+import type { PromptMessage, SystemPromptContext, UserPromptContext, UserPromptContribution } from "./prompt";
 export interface PluginHooks {
     systemPrompt?(ctx: SystemPromptContext): Promise<PromptMessage[]> | PromptMessage[];
-    userPrompt?(ctx: UserPromptContext): Promise<PromptMessage[] | undefined> | PromptMessage[] | undefined;
+    userPrompt?(ctx: UserPromptContext): Promise<UserPromptContribution[] | undefined> | UserPromptContribution[] | undefined;
     beforeToolExecute?(ctx: BeforeToolExecuteHookContext): Promise<void> | void;
     grantForEgress?(ctx: EgressHookContext): Promise<PluginGrant | undefined> | PluginGrant | undefined;
     heartbeat?(ctx: HeartbeatHookContext): Promise<HeartbeatResult | void> | HeartbeatResult | void;

package/dist/index.d.ts

@@ -2,7 +2,7 @@ export * from "./annotations";
 export * from "./schemas";
 export * from "./context";
 export * from "./state";
-export { promptMessageSchema, type PromptMessage, type SystemPromptContext, type UserPromptContext, } from "./prompt";
+export { definePromptContext, promptContextSchema, promptMessageSchema, type PromptContext, type PromptContextContribution, type PromptMessage, type SystemPromptContext, type UserPromptContribution, type UserPromptContext, } from "./prompt";
 export * from "./dispatch";
 export * from "./resource-events";
 export * from "./tasks";

package/dist/index.js

@@ -198,9 +198,25 @@ function isSlackDestination(destination) {
 
 // src/prompt.ts
 import { z as z3 } from "zod";
+var promptContextKindSchema = z3.string().trim().min(1).max(64).regex(/^[a-z][a-z0-9_-]*$/);
 var promptMessageSchema = z3.object({
   text: z3.string().trim().min(1).max(8e3)
 }).strict();
+var promptContextSchema = z3.object({
+  kind: promptContextKindSchema,
+  version: z3.number().int().positive(),
+  content: z3.record(z3.string(), z3.unknown())
+}).strict();
+function definePromptContext(definition) {
+  const identity = promptContextSchema.pick({ kind: true, version: true }).parse({ kind: definition.kind, version: definition.version });
+  return (content) => {
+    const parsed = definition.schema.parse(content);
+    return {
+      context: { ...identity, content: parsed },
+      renderPrompt: () => definition.renderPrompt(parsed)
+    };
+  };
+}
 
 // src/resource-events.ts
 import { z as z4 } from "zod";
@@ -494,6 +510,7 @@ export {
   createSlackSource,
   defineJuniorPlugin,
   definePluginTool,
+  definePromptContext,
   destinationSchema,
   destinationVisibilitySchema,
   dispatchOptionsSchema,
@@ -520,6 +537,7 @@ export {
   pluginToolContinuationSchema,
   pluginToolErrorSchema,
   pluginToolResultSchema,
+  promptContextSchema,
   promptMessageSchema,
   resourceEventSchema,
   resourceLinkAnnotationSchema,

package/dist/prompt.d.ts

@@ -6,6 +6,27 @@ export declare const promptMessageSchema: z.ZodObject<{
 }, z.core.$strict>;
 /** Small plugin-owned prompt text block rendered by Junior core. */
 export type PromptMessage = z.output<typeof promptMessageSchema>;
+export declare const promptContextSchema: z.ZodObject<{
+    kind: z.ZodString;
+    version: z.ZodNumber;
+    content: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}, z.core.$strict>;
+/** Structured plugin context retained alongside its model-visible rendering. */
+export type PromptContext = z.output<typeof promptContextSchema>;
+/** Runtime contribution produced from one validated plugin context value. */
+export interface PromptContextContribution {
+    context: PromptContext;
+    renderPrompt(): string;
+}
+/** Define one typed, versioned plugin context contribution. */
+export declare function definePromptContext<TSchema extends z.ZodType<Record<string, unknown>>>(definition: {
+    kind: string;
+    version: number;
+    schema: TSchema;
+    renderPrompt(content: z.output<TSchema>): string;
+}): (content: z.input<TSchema>) => PromptContextContribution;
+/** One request-scoped plugin contribution to the model-visible user prompt. */
+export type UserPromptContribution = PromptMessage | PromptContextContribution;
 /** Stable platform context for plugin system prompt guidance. */
 export type SystemPromptContext = Pick<PluginContext, "db" | "log" | "plugin"> & {
     platform: Platform;

package/package.json

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

package/src/hooks.ts

@@ -29,6 +29,7 @@ import type {
   PromptMessage,
   SystemPromptContext,
   UserPromptContext,
+  UserPromptContribution,
 } from "./prompt";
 
 export interface PluginHooks {
@@ -37,7 +38,10 @@ export interface PluginHooks {
   ): Promise<PromptMessage[]> | PromptMessage[];
   userPrompt?(
     ctx: UserPromptContext,
-  ): Promise<PromptMessage[] | undefined> | PromptMessage[] | undefined;
+  ):
+    | Promise<UserPromptContribution[] | undefined>
+    | UserPromptContribution[]
+    | undefined;
   beforeToolExecute?(ctx: BeforeToolExecuteHookContext): Promise<void> | void;
   grantForEgress?(
     ctx: EgressHookContext,

package/src/index.ts

@@ -3,9 +3,14 @@ export * from "./schemas";
 export * from "./context";
 export * from "./state";
 export {
+  definePromptContext,
+  promptContextSchema,
   promptMessageSchema,
+  type PromptContext,
+  type PromptContextContribution,
   type PromptMessage,
   type SystemPromptContext,
+  type UserPromptContribution,
   type UserPromptContext,
 } from "./prompt";
 export * from "./dispatch";

package/src/prompt.ts

@@ -9,6 +9,13 @@ import type {
 } from "./context";
 import type { PluginState } from "./state";
 
+const promptContextKindSchema = z
+  .string()
+  .trim()
+  .min(1)
+  .max(64)
+  .regex(/^[a-z][a-z0-9_-]*$/);
+
 export const promptMessageSchema = z
   .object({
     text: z.string().trim().min(1).max(8_000),
@@ -18,6 +25,47 @@ export const promptMessageSchema = z
 /** Small plugin-owned prompt text block rendered by Junior core. */
 export type PromptMessage = z.output<typeof promptMessageSchema>;
 
+export const promptContextSchema = z
+  .object({
+    kind: promptContextKindSchema,
+    version: z.number().int().positive(),
+    content: z.record(z.string(), z.unknown()),
+  })
+  .strict();
+
+/** Structured plugin context retained alongside its model-visible rendering. */
+export type PromptContext = z.output<typeof promptContextSchema>;
+
+/** Runtime contribution produced from one validated plugin context value. */
+export interface PromptContextContribution {
+  context: PromptContext;
+  renderPrompt(): string;
+}
+
+/** Define one typed, versioned plugin context contribution. */
+export function definePromptContext<
+  TSchema extends z.ZodType<Record<string, unknown>>,
+>(definition: {
+  kind: string;
+  version: number;
+  schema: TSchema;
+  renderPrompt(content: z.output<TSchema>): string;
+}): (content: z.input<TSchema>) => PromptContextContribution {
+  const identity = promptContextSchema
+    .pick({ kind: true, version: true })
+    .parse({ kind: definition.kind, version: definition.version });
+  return (content) => {
+    const parsed = definition.schema.parse(content);
+    return {
+      context: { ...identity, content: parsed },
+      renderPrompt: () => definition.renderPrompt(parsed),
+    };
+  };
+}
+
+/** One request-scoped plugin contribution to the model-visible user prompt. */
+export type UserPromptContribution = PromptMessage | PromptContextContribution;
+
 /** Stable platform context for plugin system prompt guidance. */
 export type SystemPromptContext = Pick<
   PluginContext,