@novu/framework 2.13.0 → 2.13.1-rc.852194fa77

package/dist/cjs/cards.d.cts

@@ -1,2 +1,2 @@
-export { Actions, ActionsElement, Button, ButtonElement, Card, CardChild, CardElement, CardLink, CardText, Divider, DividerElement, LinkElement, Select, SelectElement, SelectOption, SelectOptionElement, TextElement, TextInput, TextInputElement } from 'chat';
+export { Actions, ActionsElement, Button, ButtonElement, Card, CardChild, CardElement, CardLink, CardText, Divider, DividerElement, Image, ImageElement, LinkElement, Select, SelectElement, SelectOption, SelectOptionElement, TextElement, TextInput, TextInputElement } from 'chat';
 import 'chat/jsx-runtime';

package/dist/cjs/{health-check.types-B9FbzRbm.d.cts → health-check.types-B6RuXNc8.d.cts}

@@ -1,71 +1,8 @@
-import { a as ContextPayload, b as Step, S as Subscriber, E as EnvironmentSystemVariables, C as ContextResolved, c as ChannelStepEnum, A as ActionStepEnum, W as WithPassthrough, d as StepOptions } from './subscriber.types-DubxcL8q.cjs';
-import { I as ITriggerPayload, w as TriggerRecipientsPayload, x as ISubscriberPayload, y as TriggerEventStatusEnum, W as WorkflowPreferencesPartial } from './agent.types-Dqm2VBTO.cjs';
+import { a as ContextPayload, b as Step, S as Subscriber, E as EnvironmentSystemVariables, C as ContextResolved, c as ChannelStepEnum, A as ActionStepEnum, W as WithPassthrough, d as StepOptions } from './subscriber.types-_eHz1E0m.cjs';
+import { I as ITriggerPayload, B as TriggerRecipientsPayload, C as ISubscriberPayload, D as TriggerEventStatusEnum, W as WorkflowPreferencesPartial } from './agent.types-CQKSD7NC.cjs';
 import { C as ConditionalPartial, P as PickRequiredKeys, a as Prettify, D as DeepPartial, A as Awaitable } from './util.types-DaFfsxgy.cjs';
 import { S as Schema, J as JsonSchema } from './base.schema.types-BApIn9jr.cjs';
 
-type CodeResult = {
-    code: string;
-};
-
-/**
- * A minimal logger interface used for all of the framework's internal logging
- * (workflow discovery, execution and bridge error reporting).
- *
- * The methods (`info`/`warn`/`error`) are chosen so that both the global
- * `console` and common structured loggers (pino, winston, ...) satisfy this
- * interface directly, with no adapter. The global `console` is the default;
- * provide your own to route Novu's internal logs wherever the rest of your
- * application logs go.
- */
-type Logger = {
-    info: typeof console.info;
-    warn: typeof console.warn;
-    error: typeof console.error;
-};
-type ClientOptions = {
-    /**
-     * Use Novu Cloud US (https://api.novu.co) or EU deployment (https://eu.api.novu.co). Defaults to US.
-     */
-    apiUrl?: string;
-    /**
-     * Specify your Novu secret key, to secure the Bridge Endpoint, and Novu API communication.
-     * Novu communicates securely with your endpoint using a signed HMAC header,
-     * ensuring that only trusted requests from Novu are actioned by your Bridge API.
-     * The secret key is used to sign the HMAC header.
-     */
-    secretKey?: string;
-    /**
-     * Explicitly use HMAC signature verification.
-     * Setting this to `false` will enable Novu to communicate with your Bridge API
-     * without requiring a valid HMAC signature.
-     * This is useful for local development and testing.
-     *
-     * In production you must specify an `secretKey` and set this to `true`.
-     *
-     * Defaults to true.
-     */
-    strictAuthentication?: boolean;
-    /**
-     * Enable verbose logging for workflow discovery and execution.
-     * When set to `false`, discovery and execution logs will be suppressed.
-     * Defaults to `true` in development, `false` in production.
-     */
-    verbose?: boolean;
-    /**
-     * A custom logger used for all of the framework's internal logging
-     * (workflow discovery, execution and bridge error reporting).
-     *
-     * Defaults to the global `console`. Provide your own logger to route Novu's
-     * internal logs through your application's structured logger.
-     *
-     * Note: `verbose` still controls *whether* discovery and execution logs are
-     * emitted; `logger` only controls *where* all logs are written. Bridge errors
-     * (HTTP status >= 500) are always logged via this logger, regardless of
-     * `verbose`.
-     */
-    logger?: Logger;
-};
-
 declare enum PostActionEnum {
     TRIGGER = "trigger",
     EXECUTE = "execute",
@@ -178,7 +115,8 @@ declare enum WorkflowChannelEnum {
     PUSH = "push",
     CHAT = "chat",
     /** Differs from ChannelTypeEnum in capitalization / snake_case */
-    IN_APP = "inApp"
+    IN_APP = "inApp",
+    TOOL = "tool"
 }
 
 type EventPayload = ITriggerPayload;
@@ -223,6 +161,11 @@ type EventTriggerParams<T_Payload = EventPayload> = {
      * Overrides for trigger
      */
     overrides?: Record<string, unknown>;
+    /**
+     * Override the workflow-assigned agent for this trigger using the public agent identifier.
+     * Omit to use the workflow default; pass null to disable agent routing for this execution.
+     */
+    agentId?: string | null;
     /**
      * Controls for the step execution
      */
@@ -545,6 +488,69 @@ type DiscoverOutput = {
     agents: Array<DiscoverAgentOutput>;
 };
 
+type CodeResult = {
+    code: string;
+};
+
+/**
+ * A minimal logger interface used for all of the framework's internal logging
+ * (workflow discovery, execution and bridge error reporting).
+ *
+ * The methods (`info`/`warn`/`error`) are chosen so that both the global
+ * `console` and common structured loggers (pino, winston, ...) satisfy this
+ * interface directly, with no adapter. The global `console` is the default;
+ * provide your own to route Novu's internal logs wherever the rest of your
+ * application logs go.
+ */
+type Logger = {
+    info: typeof console.info;
+    warn: typeof console.warn;
+    error: typeof console.error;
+};
+type ClientOptions = {
+    /**
+     * Use Novu Cloud US (https://api.novu.co) or EU deployment (https://eu.api.novu.co). Defaults to US.
+     */
+    apiUrl?: string;
+    /**
+     * Specify your Novu secret key, to secure the Bridge Endpoint, and Novu API communication.
+     * Novu communicates securely with your endpoint using a signed HMAC header,
+     * ensuring that only trusted requests from Novu are actioned by your Bridge API.
+     * The secret key is used to sign the HMAC header.
+     */
+    secretKey?: string;
+    /**
+     * Explicitly use HMAC signature verification.
+     * Setting this to `false` will enable Novu to communicate with your Bridge API
+     * without requiring a valid HMAC signature.
+     * This is useful for local development and testing.
+     *
+     * In production you must specify an `secretKey` and set this to `true`.
+     *
+     * Defaults to true.
+     */
+    strictAuthentication?: boolean;
+    /**
+     * Enable verbose logging for workflow discovery and execution.
+     * When set to `false`, discovery and execution logs will be suppressed.
+     * Defaults to `true` in development, `false` in production.
+     */
+    verbose?: boolean;
+    /**
+     * A custom logger used for all of the framework's internal logging
+     * (workflow discovery, execution and bridge error reporting).
+     *
+     * Defaults to the global `console`. Provide your own logger to route Novu's
+     * internal logs through your application's structured logger.
+     *
+     * Note: `verbose` still controls *whether* discovery and execution logs are
+     * emitted; `logger` only controls *where* all logs are written. Bridge errors
+     * (HTTP status >= 500) are always logged via this logger, regardless of
+     * `verbose`.
+     */
+    logger?: Logger;
+};
+
 type Event = {
     payload: Record<string, unknown>;
     workflowId: string;

package/dist/cjs/{index-CLZZRnNV.d.cts → index-phn3kJ9H.d.cts}

@@ -1,10 +1,10 @@
-import { i as AgentHandlers, A as Agent } from './agent.types-Dqm2VBTO.cjs';
-import { L as Logger, C as ClientOptions, W as Workflow, H as HealthCheck, e as DiscoverOutput, i as Event, n as ExecuteOutput, d as CodeResult, j as EventTriggerParams, m as Execute, t as WorkflowOptions } from './health-check.types-B9FbzRbm.cjs';
+import { k as AgentHandlers, A as Agent, p as AgentNotification } from './agent.types-CQKSD7NC.cjs';
+import { W as Workflow, L as Logger, C as ClientOptions, H as HealthCheck, e as DiscoverOutput, i as Event, n as ExecuteOutput, d as CodeResult, j as EventTriggerParams, m as Execute, t as WorkflowOptions } from './health-check.types-B6RuXNc8.cjs';
 import { A as Awaitable } from './util.types-DaFfsxgy.cjs';
 import 'chat';
 import { S as Schema, a as FromSchema, F as FromSchemaUnvalidated } from './base.schema.types-BApIn9jr.cjs';
 import './step-resolver.cjs';
-import './subscriber.types-DubxcL8q.cjs';
+import './subscriber.types-_eHz1E0m.cjs';
 
 /**
  * Define a new conversational agent.
@@ -14,6 +14,11 @@ import './subscriber.types-DubxcL8q.cjs';
  */
 declare function agent(agentId: string, handlers: AgentHandlers): Agent;
 
+/**
+ * Narrows `notification.payload` to the workflow's schema when `workflowId` matches `workflow.id`.
+ */
+declare function isFromWorkflow<T extends Record<string, unknown>>(notification: AgentNotification | null, workflow: Workflow<T>): notification is AgentNotification<T>;
+
 declare class Client {
     private discoveredWorkflows;
     private discoverWorkflowPromises;
@@ -64,9 +69,16 @@ declare class Client {
     private createExecutionPayload;
     private prettyPrintExecute;
     private executeProviders;
-    private previewProvider;
-    private executeProvider;
+    private runProvider;
+    private resolveProviderOutput;
     private executeStep;
+    /**
+     * Code-first chat steps may return `card` as a `chat` JSX element (e.g. `Card(...)`) or a plain
+     * `CardElement`. Normalize it to plain `CardElement` JSON before validation so it matches the
+     * chat output schema and can cross the bridge unchanged. Non-chat steps and card-less outputs
+     * pass through untouched.
+     */
+    private normalizeChatCardOutput;
     private compileControls;
     /**
      * Preprocesses standalone translation patterns.
@@ -190,4 +202,4 @@ declare class NovuRequestHandler<Input extends any[] = any[], Output = any> {
  */
 declare function workflow<T_PayloadSchema extends Schema, T_ControlSchema extends Schema, T_EnvSchema extends Schema, T_PayloadValidated extends Record<string, unknown> = FromSchema<T_PayloadSchema>, T_PayloadUnvalidated extends Record<string, unknown> = FromSchemaUnvalidated<T_PayloadSchema>, T_Controls extends Record<string, unknown> = FromSchema<T_ControlSchema>, T_Env extends Record<string, unknown> = FromSchema<T_EnvSchema>>(workflowId: string, execute: Execute<T_PayloadValidated, T_Controls, T_Env>, workflowOptions?: WorkflowOptions<T_PayloadSchema, T_ControlSchema, T_EnvSchema>): Workflow<T_PayloadUnvalidated>;
 
-export { Client as C, type INovuRequestHandlerOptions as I, NovuRequestHandler as N, type ServeHandlerOptions as S, agent as a, workflow as w };
+export { Client as C, type INovuRequestHandlerOptions as I, NovuRequestHandler as N, type ServeHandlerOptions as S, agent as a, isFromWorkflow as i, workflow as w };