@sentry/junior-plugin-api 0.197.0 → 0.199.0

package/dist/hooks.d.ts

@@ -1,43 +0,0 @@
-import type { ConversationSidebarHookContext, ConversationSidebarResult } from "./annotations";
-import type { EgressHookContext, EgressResponseHookContext, IssueCredentialHookContext, PluginCredentialResult, PluginGrant, PluginProviderAccount, ResolveOAuthAccountHookContext } from "./credentials";
-import type { HeartbeatHookContext, HeartbeatResult, OperationalReportHookContext, ProfileReportHookContext, ApiRouteRegistrationHookContext, PluginOperationalReportContent, PluginRoute, PluginRouteApp, RouteRegistrationHookContext, SlackConversationLink, SlackConversationLinkHookContext, UnfinishedWorkHookContext, UnfinishedWorkResult } from "./operations";
-import type { AfterMcpToolHookContext, BeforeToolExecuteHookContext, PluginToolDefinition, SandboxPrepareHookContext, ToolRegistrationHookContext, WorkspacePrepareHookContext } from "./tools";
-import type { PromptMessage, SystemPromptContext, UserPromptContext, UserPromptContribution } from "./prompt";
-/** Input for a pure Markdown rewrite before destination delivery formatting. */
-export interface FormatMarkdownHookContext {
-    text: string;
-}
-export interface PluginHooks {
-    conversationSidebar?(ctx: ConversationSidebarHookContext): Promise<ConversationSidebarResult> | ConversationSidebarResult;
-    systemPrompt?(ctx: SystemPromptContext): Promise<PromptMessage[]> | PromptMessage[];
-    userPrompt?(ctx: UserPromptContext): Promise<UserPromptContribution[] | undefined> | UserPromptContribution[] | undefined;
-    beforeToolExecute?(ctx: BeforeToolExecuteHookContext): Promise<void> | void;
-    /**
-     * Run after a successful hosted MCP tool call.
-     *
-     * Prefer this for junior-owned side effects such as conversation annotations.
-     * Do not use it to invent a parallel tool contract for the provider tool.
-     */
-    afterMcpTool?(ctx: AfterMcpToolHookContext): Promise<void> | void;
-    grantForEgress?(ctx: EgressHookContext): Promise<PluginGrant | undefined> | PluginGrant | undefined;
-    heartbeat?(ctx: HeartbeatHookContext): Promise<HeartbeatResult | void> | HeartbeatResult | void;
-    unfinishedWork?(ctx: UnfinishedWorkHookContext): Promise<UnfinishedWorkResult> | UnfinishedWorkResult;
-    issueCredential?(ctx: IssueCredentialHookContext): Promise<PluginCredentialResult> | PluginCredentialResult;
-    onEgressResponse?(ctx: EgressResponseHookContext): Promise<void> | void;
-    operationalReport?(ctx: OperationalReportHookContext): Promise<PluginOperationalReportContent | undefined> | PluginOperationalReportContent | undefined;
-    /**
-     * Return one person-scoped operational report for a profile page.
-     * Omit or return undefined when the plugin has nothing to show for the subject.
-     */
-    profileReport?(ctx: ProfileReportHookContext): Promise<PluginOperationalReportContent | undefined> | PluginOperationalReportContent | undefined;
-    /** Return plugin-owned product API routes mounted under Junior's authenticated plugin namespace. */
-    apiRoutes?(ctx: ApiRouteRegistrationHookContext): PluginRouteApp | undefined;
-    resolveOAuthAccount?(ctx: ResolveOAuthAccountHookContext): Promise<PluginProviderAccount | undefined> | PluginProviderAccount | undefined;
-    routes?(ctx: RouteRegistrationHookContext): PluginRoute[];
-    sandboxPrepare?(ctx: SandboxPrepareHookContext): Promise<void> | void;
-    workspacePrepare?(ctx: WorkspacePrepareHookContext): Promise<void> | void;
-    slackConversationLink?(ctx: SlackConversationLinkHookContext): SlackConversationLink | undefined;
-    /** Pure Markdown rewrite. Emit ordinary Markdown only. */
-    formatMarkdown?(ctx: FormatMarkdownHookContext): string;
-    tools?(ctx: ToolRegistrationHookContext): Record<string, PluginToolDefinition>;
-}

package/dist/manifest.d.ts

@@ -1,76 +0,0 @@
-export interface PluginOAuthConfig {
-    authorizeEndpoint: string;
-    authorizeParams?: Record<string, string>;
-    clientIdEnv: string;
-    clientSecretEnv: string;
-    scope?: string;
-    /**
-     * Treat a provider token response with `scope: ""` like an omitted scope and
-     * fall back to the requested scope string when storing the token.
-     */
-    treatEmptyScopeAsUnreported?: boolean;
-    tokenAuthMethod?: "body" | "basic";
-    tokenEndpoint: string;
-    tokenExtraHeaders?: Record<string, string>;
-}
-export interface PluginOAuthBearerCredentials {
-    apiHeaders?: Record<string, string>;
-    authTokenEnv: string;
-    authTokenPlaceholder?: string;
-    domains: string[];
-    type: "oauth-bearer";
-}
-export type PluginCredentials = PluginOAuthBearerCredentials;
-export interface PluginNpmRuntimeDependency {
-    package: string;
-    type: "npm";
-    version: string;
-}
-export interface PluginSystemRuntimeDependency {
-    package: string;
-    type: "system";
-}
-export interface PluginSystemRuntimeDependencyFromUrl {
-    sha256: string;
-    type: "system";
-    url: string;
-}
-export type PluginRuntimeDependency = PluginNpmRuntimeDependency | PluginSystemRuntimeDependency | PluginSystemRuntimeDependencyFromUrl;
-export interface PluginRuntimePostinstallCommand {
-    args?: string[];
-    cmd: string;
-    sudo?: boolean;
-}
-export interface PluginMcpConfig {
-    /** Provider tools exposed directly to the model. */
-    allowedTools?: string[];
-    headers?: Record<string, string>;
-    transport: "http";
-    url: string;
-    /** Provider tools hidden from the model and callable only by plugin-owned wrapper tools. */
-    wrappedTools?: string[];
-}
-export interface PluginEnvVarDeclaration {
-    default?: string;
-    exposeToCommandEnv?: boolean;
-}
-export interface PluginManifest {
-    apiHeaders?: Record<string, string>;
-    commandEnv?: Record<string, string>;
-    configKeys?: string[];
-    credentials?: PluginCredentials;
-    description: string;
-    displayName: string;
-    domains?: string[];
-    envVars?: Record<string, PluginEnvVarDeclaration>;
-    mcp?: PluginMcpConfig;
-    name: string;
-    oauth?: PluginOAuthConfig;
-    runtimeDependencies?: PluginRuntimeDependency[];
-    runtimePostinstall?: PluginRuntimePostinstallCommand[];
-    target?: {
-        commandFlags?: string[];
-        configKey: string;
-        type: string;
-    };
-}

package/dist/operations.d.ts

@@ -1,153 +0,0 @@
-import { z } from "zod";
-import type { PluginContext, User } from "./context";
-import type { Dispatch, DispatchOptions, DispatchResult } from "./dispatch";
-import type { PluginReadState, PluginState } from "./state";
-import type { ResourceEventPublisher } from "./resource-events";
-import type { PluginConversationAnnotations } from "./annotations";
-import type { PluginConversationEventStats } from "./conversation-events";
-import type { CodeChangePublisher } from "./code";
-export interface HeartbeatHookContext extends PluginContext {
-    agent: {
-        dispatch(options: DispatchOptions): Promise<DispatchResult>;
-        get(id: string): Promise<Dispatch | undefined>;
-    };
-    nowMs: number;
-    state: PluginState;
-}
-export interface HeartbeatResult {
-    dispatchCount?: number;
-}
-export interface UnfinishedWorkHookContext extends PluginContext {
-    /** Bounded conversation candidates selected by the host. */
-    conversationIds: string[];
-}
-export interface UnfinishedWorkResult {
-    /** Candidate conversations that have plugin-owned work to finish. */
-    conversationIds: string[];
-    /**
-     * Candidate conversations that have any associated plugin-owned work,
-     * finished or unfinished. Omit when the plugin cannot distinguish assignment.
-     *
-     * The host uses this with unfinished work and finish times to set feed
-     * `isPriority`. Finished assigned work stays out of Priority unless the
-     * conversation has activity after the finish time.
-     */
-    assignedConversationIds?: string[];
-    /**
-     * Latest time when all known work finished, keyed by conversation id.
-     * ISO-8601 timestamps. Used with conversation activity to decide whether
-     * finished work still belongs in Priority.
-     */
-    finishedWorkAtByConversationId?: Record<string, string>;
-}
-export type PluginOperationalTone = "danger" | "good" | "neutral" | "warning";
-export interface PluginOperationalMetric {
-    label: string;
-    tone?: PluginOperationalTone;
-    value: string;
-}
-export interface PluginOperationalField {
-    key: string;
-    label: string;
-}
-export interface PluginOperationalRecord {
-    id: string;
-    tone?: PluginOperationalTone;
-    values: Record<string, string>;
-}
-export interface PluginOperationalRecordSet {
-    fields?: PluginOperationalField[];
-    emptyText?: string;
-    records?: PluginOperationalRecord[];
-    title: string;
-}
-export interface PluginOperationalChartSeries {
-    format?: "usd";
-    key: string;
-    label: string;
-    tone?: PluginOperationalTone;
-}
-export interface PluginOperationalChartCategory {
-    id: string;
-    label: string;
-    values: Record<string, number>;
-}
-export interface PluginOperationalBarChartWidget {
-    categories: PluginOperationalChartCategory[];
-    description?: string;
-    emptyText?: string;
-    id: string;
-    series: PluginOperationalChartSeries[];
-    timeRangeDays?: Array<1 | 7 | 30 | 90>;
-    title: string;
-    type: "bar_chart";
-}
-export interface PluginOperationalReportContent {
-    generatedAt?: string;
-    metrics?: PluginOperationalMetric[];
-    recordSets?: PluginOperationalRecordSet[];
-    title?: string;
-    widgets?: PluginOperationalBarChartWidget[];
-}
-export interface PluginOperationalReport extends PluginOperationalReportContent {
-    pluginName: string;
-}
-export interface OperationalReportHookContext extends PluginContext {
-    eventStats: PluginConversationEventStats;
-    nowMs: number;
-    state: PluginReadState;
-}
-/** Read-only context for one person-scoped plugin report on a profile page. */
-export interface ProfileReportHookContext extends PluginContext {
-    nowMs: number;
-    state: PluginReadState;
-    /** Canonical user for the profile being viewed. */
-    subject: User;
-    /** Canonical user for the authenticated viewer. */
-    viewer: User;
-}
-export type PluginRouteMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS" | "ALL";
-export type PluginRouteHandler = {
-    bivarianceHack(request: Request): Promise<Response> | Response;
-}["bivarianceHack"];
-export interface PluginRoute {
-    handler: PluginRouteHandler;
-    method?: PluginRouteMethod | PluginRouteMethod[];
-    path: string;
-}
-/** Fetch-compatible plugin HTTP app mounted by Junior. */
-export type PluginRouteApp = {
-    fetch(request: Request, context?: PluginApiRouteRequestContext): Promise<Response> | Response;
-};
-export interface RouteRegistrationHookContext extends PluginContext {
-    annotations: PluginConversationAnnotations;
-    /** Provider-neutral write boundary for Junior's native code index. */
-    codeChanges: CodeChangePublisher;
-    /** Core-owned delivery boundary for provider webhook events. */
-    resourceEvents: ResourceEventPublisher;
-}
-export interface ApiRouteRegistrationHookContext extends PluginContext {
-    eventStats: PluginConversationEventStats;
-    users: {
-        /** Resolve or create the canonical user for one verified email. */
-        resolve(email: string): Promise<User | undefined>;
-    };
-}
-/** Per-request context Junior passes to authenticated plugin product API routes. */
-export declare const pluginApiRouteRequestContextSchema: z.ZodObject<{
-    auth: z.ZodObject<{
-        user: z.ZodObject<{
-            email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-            emailVerified: z.ZodOptional<z.ZodBoolean>;
-            name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        }, z.core.$strict>;
-    }, z.core.$strict>;
-    pluginName: z.ZodString;
-}, z.core.$strict>;
-export type PluginApiRouteRequestContext = z.output<typeof pluginApiRouteRequestContextSchema>;
-export interface SlackConversationLink {
-    url: string;
-}
-export interface SlackConversationLinkHookContext extends PluginContext {
-    conversationId: string;
-}

package/dist/prompt.d.ts

@@ -1,56 +0,0 @@
-import { z } from "zod";
-import type { Destination, Platform, PluginContext, PluginEmbedder, PluginModel, Actor, Identity, Source, User } from "./context";
-import type { PluginState } from "./state";
-import type { PluginConversationEvents } from "./conversation-events";
-export declare const promptMessageSchema: z.ZodObject<{
-    text: z.ZodString;
-}, 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;
-};
-/** Runtime facts available while building plugin user prompt context. */
-export type UserPromptContext = Pick<PluginContext, "db" | "log" | "plugin"> & {
-    conversationId?: string;
-    destination: Destination;
-    embedder: PluginEmbedder;
-    /** Conversation-bound event writer when the prompt belongs to a durable turn. */
-    events?: PluginConversationEvents;
-    model: PluginModel;
-    /** Location associated with this Conversation. */
-    locationId?: string;
-    actor?: Actor;
-    source: Source;
-    state: PluginState;
-    text: string;
-    users: {
-        /** Resolve the current Actor's Identity and User. */
-        resolveActor(): Promise<{
-            identity: Identity;
-            user?: User;
-        } | undefined>;
-    };
-};

package/dist/registration.d.ts

@@ -1,28 +0,0 @@
-import type { PluginCliDefinition } from "./cli";
-import type { PluginConversationEventDefinition } from "./conversation-events";
-import type { PluginHooks } from "./hooks";
-import type { PluginManifest } from "./manifest";
-import type { PluginTasks } from "./tasks";
-import type { PluginUserPageDefinition } from "./user-pages";
-import { type PluginResourceEvents } from "./resource-events";
-export interface PluginModelConfig {
-    /** Host model family used when no explicit structured model id is configured. */
-    structuredModel?: "default" | "fast";
-    /** Host model id used for this plugin's structured model calls. */
-    structuredModelId?: string;
-}
-export type PluginRegistrationInput = {
-    cli?: PluginCliDefinition;
-    conversationEvents?: PluginConversationEventDefinition[];
-    hooks?: PluginHooks;
-    manifest: PluginManifest;
-    model?: PluginModelConfig;
-    packageName?: string;
-    resourceEvents?: PluginResourceEvents;
-    tasks?: PluginTasks;
-    userPages?: PluginUserPageDefinition[];
-};
-export interface PluginRegistration extends PluginRegistrationInput {
-}
-/** Define one Junior plugin registration for app and build-time wiring. */
-export declare function defineJuniorPlugin(plugin: PluginRegistrationInput): PluginRegistration;

package/dist/resource-events.d.ts

@@ -1,128 +0,0 @@
-import { z } from "zod";
-export declare const RESOURCE_EVENT_SUMMARY_MAX_LENGTH = 4000;
-export declare const RESOURCE_EVENT_TEXT_MAX_LENGTH = 8000;
-export declare const RESOURCE_EVENT_DATA_MAX_KEYS = 32;
-export declare const RESOURCE_EVENT_DATA_MAX_JSON_BYTES = 4000;
-export declare const RESOURCE_EVENT_GUIDANCE_MAX_LENGTH = 1000;
-/** Small trusted data from the plugin. The agent should not look these up again. */
-export declare const resourceEventDataSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-/** Canonical dotted event type published and selected across plugins. */
-export declare const resourceEventTypeSchema: z.ZodString;
-export declare const resourceTypeSchema: z.ZodString;
-/** One exact value a watch or event task may require on trusted event data. */
-export declare const resourceEventMatchFieldSchema: z.ZodObject<{
-    kind: z.ZodEnum<{
-        string: "string";
-        number: "number";
-        boolean: "boolean";
-    }>;
-    description: z.ZodString;
-    enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
-}, z.core.$strict>;
-export declare const resourceEventMatchFieldsSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
-    kind: z.ZodEnum<{
-        string: "string";
-        number: "number";
-        boolean: "boolean";
-    }>;
-    description: z.ZodString;
-    enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
-}, z.core.$strict>>;
-/** Exact trusted values required before a watch or event task runs. */
-export declare const resourceEventMatchSchema: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodBoolean, z.ZodNumber, z.ZodString, z.ZodArray<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>]>>;
-export type ResourceEventMatch = z.output<typeof resourceEventMatchSchema>;
-export type ResourceEventMatchFields = z.output<typeof resourceEventMatchFieldsSchema>;
-/** Stable JSON for one match object. List order does not matter. */
-export declare function stableResourceEventMatchKey(match: ResourceEventMatch | undefined): string;
-/** Return whether trusted event data matches one exact match object. */
-export declare function resourceEventMatches(match: ResourceEventMatch | undefined, data: ResourceEventData | undefined): boolean;
-export declare const pluginResourceEventTypeSchema: z.ZodObject<{
-    type: z.ZodString;
-    supportedEvents: z.ZodArray<z.ZodString>;
-    suggestedEvents: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    matchFields: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
-        kind: z.ZodEnum<{
-            string: "string";
-            number: "number";
-            boolean: "boolean";
-        }>;
-        description: z.ZodString;
-        enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    }, z.core.$strict>>>;
-    guidance: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-}, z.core.$strict>;
-export declare const pluginResourceEventsSchema: z.ZodObject<{
-    resourceTypes: z.ZodArray<z.ZodObject<{
-        type: z.ZodString;
-        supportedEvents: z.ZodArray<z.ZodString>;
-        suggestedEvents: z.ZodOptional<z.ZodArray<z.ZodString>>;
-        matchFields: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
-            kind: z.ZodEnum<{
-                string: "string";
-                number: "number";
-                boolean: "boolean";
-            }>;
-            description: z.ZodString;
-            enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
-        }, z.core.$strict>>>;
-        guidance: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-    }, z.core.$strict>>;
-    isEnabled: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodBoolean>>;
-    normalizeIdentifier: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodString], null>, z.ZodString>>;
-}, z.core.$strict>;
-export type PluginResourceEventType = z.output<typeof pluginResourceEventTypeSchema>;
-export type PluginResourceEvents = z.output<typeof pluginResourceEventsSchema>;
-/** Apply a plugin's identifier convention at resource-event boundaries. */
-export declare function normalizeResourceEventIdentifier(registration: Pick<PluginResourceEvents, "normalizeIdentifier"> | undefined, identifier: string): string;
-export declare const subscribableResourceSchema: z.ZodObject<{
-    identifier: z.ZodString;
-    label: z.ZodString;
-    namespace: z.ZodString;
-    suggestedEvents: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    supportedEvents: z.ZodArray<z.ZodString>;
-    type: z.ZodString;
-}, z.core.$strict>;
-export type SubscribableResource = z.output<typeof subscribableResourceSchema>;
-/** Result returned after a temporary resource subscription is created. */
-export declare const resourceEventSubscriptionResultSchema: z.ZodObject<{
-    events: z.ZodArray<z.ZodString>;
-    id: z.ZodString;
-}, z.core.$strict>;
-export type ResourceEventSubscriptionResult = z.output<typeof resourceEventSubscriptionResultSchema>;
-export declare const resourceEventInputSchema: z.ZodObject<{
-    eventKey: z.ZodString;
-    eventType: z.ZodString;
-    identifier: z.ZodString;
-    occurredAtMs: z.ZodNumber;
-    terminal: z.ZodOptional<z.ZodBoolean>;
-    trustedSummary: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
-    data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    untrustedText: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>;
-}, z.core.$strict>;
-export type ResourceEventData = z.output<typeof resourceEventDataSchema>;
-export type ResourceEventInput = z.output<typeof resourceEventInputSchema>;
-export declare const resourceEventSchema: z.ZodObject<{
-    eventKey: z.ZodString;
-    eventType: z.ZodString;
-    identifier: z.ZodString;
-    occurredAtMs: z.ZodNumber;
-    terminal: z.ZodOptional<z.ZodBoolean>;
-    trustedSummary: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
-    data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    untrustedText: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>;
-    namespace: z.ZodString;
-}, z.core.$strict>;
-export type ResourceEvent = z.output<typeof resourceEventSchema>;
-export interface ResourceEventPublisher {
-    /** Publish one normalized event under the owning plugin's namespace. */
-    publish(event: ResourceEventInput): Promise<void>;
-    /**
-     * Return match keys used by active watches or event tasks for these
-     * identifiers and event types. Plugins use this to load optional trusted
-     * data only when a filter needs it.
-     */
-    neededMatchKeys?(input: {
-        eventTypes: string[];
-        identifiers: string[];
-    }): Promise<string[]>;
-}