@novu/framework 0.24.3-alpha.11 → 0.24.3-alpha.12

package/dist/{handler-y6PZIhGI.d.ts → handler-PIXNhv7t.d.ts}

@@ -8,20 +8,23 @@ type CodeResult = {
 
 type ClientOptions = {
     /**
-     * Specify your Novu API key, to secure your Bridge API endpoint.
+     * @deprecated use `secretKey` instead
+     */
+    apiKey?: 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 API key is used to sign the HMAC header.
+     * The secret key is used to sign the HMAC header.
      */
-    apiKey?: string;
+    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.
      *
-     * You are strongly encouraged to specify an `apiKey` and set this to `true` in production,
-     * to ensure that only trusted requests from Novu are actioned by your Bridge API.
+     * In production you must specify an `secretKey` and set this to `true`.
      *
      * Defaults to true.
      */
@@ -3170,7 +3173,7 @@ type HealthCheck = {
 declare class Client {
     private discoveredWorkflows;
     private templateEngine;
-    apiKey?: string;
+    secretKey?: string;
     version: string;
     strictAuthentication: boolean;
     constructor(options?: ClientOptions);

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { S as Schema, J as JsonSchema, F as FromSchema, E as Execute, W as WorkflowOptions, D as DiscoverWorkflowOutput } from './handler-y6PZIhGI.js';
-export { A as ActionStep, Y as ActionStepEnum, R as Awaitable, p as ChannelStep, X as ChannelStepEnum, v as ChatOutput, w as ChatResult, C as Client, c as ClientOptions, b as CodeResult, o as CustomStep, y as DelayOutput, z as DelayResult, K as DigestOutput, L as DigestResult, g as DiscoverOutput, e as DiscoverProviderOutput, f as DiscoverStepOutput, Q as Either, q as EmailOutput, r as EmailResult, h as Event, U as ExecuteInput, k as ExecuteOutput, j as ExecuteOutputMetadata, H as HealthCheck, I as InAppOutput, x as InAppResult, n as JobStatusEnum, N as NovuRequestHandler, P as PushOutput, u as PushResult, a as ServeHandlerOptions, V as Skip, s as SmsOutput, t as SmsResult, i as State, M as Step, m as StepOptions, d as StepType, O as Subscriber, l as SupportedFrameworkName, T as TriggerEvent, B as digestRegularOutput, G as digestTimedOutput } from './handler-y6PZIhGI.js';
+import { S as Schema, J as JsonSchema, F as FromSchema, E as Execute, W as WorkflowOptions, D as DiscoverWorkflowOutput } from './handler-PIXNhv7t.js';
+export { A as ActionStep, Y as ActionStepEnum, R as Awaitable, p as ChannelStep, X as ChannelStepEnum, v as ChatOutput, w as ChatResult, C as Client, c as ClientOptions, b as CodeResult, o as CustomStep, y as DelayOutput, z as DelayResult, K as DigestOutput, L as DigestResult, g as DiscoverOutput, e as DiscoverProviderOutput, f as DiscoverStepOutput, Q as Either, q as EmailOutput, r as EmailResult, h as Event, U as ExecuteInput, k as ExecuteOutput, j as ExecuteOutputMetadata, H as HealthCheck, I as InAppOutput, x as InAppResult, n as JobStatusEnum, N as NovuRequestHandler, P as PushOutput, u as PushResult, a as ServeHandlerOptions, V as Skip, s as SmsOutput, t as SmsResult, i as State, M as Step, m as StepOptions, d as StepType, O as Subscriber, l as SupportedFrameworkName, T as TriggerEvent, B as digestRegularOutput, G as digestTimedOutput } from './handler-PIXNhv7t.js';
 import { ValidateFunction as ValidateFunction$1 } from 'ajv';
 import { ParseReturnType } from 'zod';
 import 'json-schema-to-ts';
@@ -41,7 +41,7 @@ declare enum ErrorCodeEnum {
     EXECUTION_STATE_CONTROL_INVALID_ERROR = "ExecutionStateControlInvalidError",
     METHOD_NOT_ALLOWED_ERROR = "MethodNotAllowedError",
     INVALID_ACTION_ERROR = "InvalidActionError",
-    MISSING_API_KEY_ERROR = "MissingApiKeyError",
+    MISSING_SECRET_KEY_ERROR = "MissingSecretKeyError",
     SIGNATURE_MISMATCH_ERROR = "SignatureMismatchError",
     SIGNATURE_NOT_FOUND_ERROR = "SignatureNotFoundError",
     SIGNATURE_INVALID_ERROR = "SignatureInvalidError",