@ever-works/novu-channel-plugin 1.0.0 → 1.0.5

package/dist/index.d.cts

@@ -0,0 +1,37 @@
+import { INotificationChannelPlugin, PluginCategory, ChannelShape, JsonSchema, ChannelTargetConfig, ChannelOptions, ChannelVerification, ChannelSendInput, ChannelSendResult } from '@ever-works/plugin';
+
+/**
+ * Novu notification channel — delegates to a Novu workflow via the
+ * Trigger API (raw fetch; no `@novu/node` runtime dep). Novu fans the
+ * event out across its own configured channel steps (in-app, email,
+ * SMS, push, chat), so this plugin's `shape` is `workflow`.
+ *
+ * The `text` plus any `novu-payload` rich content is merged into the
+ * trigger `payload`, available to the workflow's step templates.
+ */
+declare class NovuChannelPlugin implements INotificationChannelPlugin {
+    readonly id = "novu-channel";
+    readonly name = "Novu";
+    readonly version = "1.0.0";
+    readonly category: PluginCategory;
+    readonly capabilities: readonly ["notification-channel", "notification-channel-novu"];
+    readonly shape: ChannelShape;
+    readonly settingsSchema: JsonSchema;
+    onLoad(): Promise<void>;
+    onUnload(): Promise<void>;
+    private readonly idempotencyCache;
+    private apiBase;
+    /**
+     * Security (SSRF): build the absolute Novu API URL from the
+     * tenant-controlled `apiBase` and reject it if the destination host is a
+     * literal private/loopback/link-local/cloud-metadata IP or a non-HTTP(S)
+     * scheme before any request (and the API key) leaves the process. Mirrors
+     * `MakeClient.buildUrl()`.
+     */
+    private safeNovuUrl;
+    verifyTarget(config: ChannelTargetConfig, options: ChannelOptions): Promise<ChannelVerification>;
+    send(payload: ChannelSendInput, options: ChannelOptions): Promise<ChannelSendResult>;
+}
+declare const novuChannelPlugin: NovuChannelPlugin;
+
+export { NovuChannelPlugin, novuChannelPlugin };

package/dist/index.d.ts

@@ -0,0 +1,37 @@
+import { INotificationChannelPlugin, PluginCategory, ChannelShape, JsonSchema, ChannelTargetConfig, ChannelOptions, ChannelVerification, ChannelSendInput, ChannelSendResult } from '@ever-works/plugin';
+
+/**
+ * Novu notification channel — delegates to a Novu workflow via the
+ * Trigger API (raw fetch; no `@novu/node` runtime dep). Novu fans the
+ * event out across its own configured channel steps (in-app, email,
+ * SMS, push, chat), so this plugin's `shape` is `workflow`.
+ *
+ * The `text` plus any `novu-payload` rich content is merged into the
+ * trigger `payload`, available to the workflow's step templates.
+ */
+declare class NovuChannelPlugin implements INotificationChannelPlugin {
+    readonly id = "novu-channel";
+    readonly name = "Novu";
+    readonly version = "1.0.0";
+    readonly category: PluginCategory;
+    readonly capabilities: readonly ["notification-channel", "notification-channel-novu"];
+    readonly shape: ChannelShape;
+    readonly settingsSchema: JsonSchema;
+    onLoad(): Promise<void>;
+    onUnload(): Promise<void>;
+    private readonly idempotencyCache;
+    private apiBase;
+    /**
+     * Security (SSRF): build the absolute Novu API URL from the
+     * tenant-controlled `apiBase` and reject it if the destination host is a
+     * literal private/loopback/link-local/cloud-metadata IP or a non-HTTP(S)
+     * scheme before any request (and the API key) leaves the process. Mirrors
+     * `MakeClient.buildUrl()`.
+     */
+    private safeNovuUrl;
+    verifyTarget(config: ChannelTargetConfig, options: ChannelOptions): Promise<ChannelVerification>;
+    send(payload: ChannelSendInput, options: ChannelOptions): Promise<ChannelSendResult>;
+}
+declare const novuChannelPlugin: NovuChannelPlugin;
+
+export { NovuChannelPlugin, novuChannelPlugin };