@betternotify/zapier 0.0.2-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Better-Notify contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,188 @@
+import * as _betternotify_core0 from "@betternotify/core";
+import { LoggerLike, Transport as Transport$1 } from "@betternotify/core";
+import { HttpClientBehaviorOptions, MockTransport } from "@betternotify/core/transports";
+import * as _betternotify_email0 from "@betternotify/email";
+
+//#region src/types.d.ts
+type RenderedZapier = {
+  event: string;
+  data: Record<string, unknown>;
+  meta?: Record<string, string>;
+  webhookUrl?: string;
+};
+type ZapierSendArgs<TInput = unknown> = {
+  input: TInput;
+};
+/**
+ * Wire format for the Zapier channel webhook POST body.
+ *
+ * The payload is intentionally semi-opinionated: envelope fields (`event`, `route`,
+ * `messageId`, `timestamp`) are auto-injected so Zapier users always have stable,
+ * consistent top-level fields to filter and branch on — without requiring every
+ * route to redeclare them. The `data` field is fully user-defined (whatever the
+ * `.data()` slot resolver returns), keeping business payloads flexible. Optional
+ * `meta` provides a filtering namespace separate from `data` so automation routing
+ * logic doesn't couple to domain models.
+ */
+type ZapierWebhookPayload = {
+  event: string;
+  route: string;
+  messageId: string;
+  timestamp: string;
+  data: Record<string, unknown>;
+  meta?: Record<string, string>;
+};
+/**
+ * Wire format for the Zapier email transport POST body.
+ *
+ * Mirrors `RenderedMessage` fields as flat, individually-addressable JSON so Zapier
+ * users can map each field (subject, html, to[0].email, etc.) to downstream actions
+ * without parsing. Addresses are normalized to `{ name?, email }` objects rather than
+ * RFC 5322 strings for the same reason. Envelope fields (`type`, `route`, `messageId`,
+ * `timestamp`) are injected for consistent filtering across both channel and email
+ * payloads.
+ */
+type ZapierEmailPayload = {
+  type: 'email';
+  route: string;
+  messageId: string;
+  timestamp: string;
+  from: {
+    name?: string;
+    email: string;
+  } | null;
+  to: Array<{
+    name?: string;
+    email: string;
+  }>;
+  cc: Array<{
+    name?: string;
+    email: string;
+  }>;
+  bcc: Array<{
+    name?: string;
+    email: string;
+  }>;
+  replyTo: {
+    name?: string;
+    email: string;
+  } | null;
+  subject: string;
+  html: string;
+  text: string | null;
+  headers: Record<string, string>;
+  tags: Record<string, string | number | boolean>;
+  attachments: Array<{
+    filename: string;
+    content: string;
+    contentType?: string;
+  }>;
+};
+//#endregion
+//#region src/channel.d.ts
+/** Static event name or resolver. Constrained to `TEvent` when the channel is generic. */
+type EventResolver<TInput, TEvent extends string = string> = TEvent | ((args: {
+  input: TInput;
+  ctx: unknown;
+}) => TEvent);
+/** Static object or resolver returning the webhook data payload. */
+type DataResolver<TInput> = Record<string, unknown> | ((args: {
+  input: TInput;
+  ctx: unknown;
+}) => Record<string, unknown>);
+/** Static object or resolver returning envelope metadata for filtering. */
+type MetaResolver<TInput> = Record<string, string> | ((args: {
+  input: TInput;
+  ctx: unknown;
+}) => Record<string, string>);
+/**
+ * Zapier notification channel with event, data, meta, and webhookUrl slots.
+ *
+ * Pass a string union generic to constrain allowed event names:
+ * ```ts
+ * const zapier = zapierChannel<'order.created' | 'payment.failed'>();
+ * ```
+ */
+declare const zapierChannel: <TEvent extends string = string>() => _betternotify_core0.Channel<"zapier", _betternotify_core0.ChannelBuilder<unknown, {
+  event: TEvent;
+  data: Record<string, unknown>;
+  meta: Record<string, string>;
+  webhookUrl: string;
+}, {
+  event: _betternotify_core0.SlotConfig<"resolver"> & {
+    required: true;
+    __value?: TEvent | undefined;
+    optional: () => _betternotify_core0.SlotConfig<"resolver"> & {
+      required: false;
+      __value?: TEvent | undefined;
+      optional: /*elided*/any;
+    };
+  };
+  data: _betternotify_core0.SlotConfig<"resolver"> & {
+    required: true;
+    __value?: Record<string, unknown> | undefined;
+    optional: () => _betternotify_core0.SlotConfig<"resolver"> & {
+      required: false;
+      __value?: Record<string, unknown> | undefined;
+      optional: /*elided*/any;
+    };
+  };
+  meta: _betternotify_core0.SlotConfig<"resolver"> & {
+    required: false;
+    __value?: Record<string, string> | undefined;
+    optional: () => _betternotify_core0.SlotConfig<"resolver"> & /*elided*/any;
+  };
+  webhookUrl: _betternotify_core0.SlotConfig<"resolver"> & {
+    required: false;
+    __value?: string | undefined;
+    optional: () => _betternotify_core0.SlotConfig<"resolver"> & /*elided*/any;
+  };
+}, Omit<{
+  input: unknown;
+}, "input">, RenderedZapier>, {
+  input: unknown;
+}, RenderedZapier, _betternotify_core0.Transport<RenderedZapier, unknown>>;
+//#endregion
+//#region src/transports/types.d.ts
+type ZapierChannelTransportData = {
+  status: number;
+  raw: unknown;
+};
+type Transport = Transport$1<RenderedZapier, ZapierChannelTransportData>;
+//#endregion
+//#region src/transports/channel-transport.types.d.ts
+type ZapierChannelTransportOptions = {
+  webhookUrl: string;
+  timeoutMs?: number;
+  logger?: LoggerLike;
+  http?: HttpClientBehaviorOptions;
+};
+//#endregion
+//#region src/transports/channel-transport.d.ts
+/** Zapier channel transport — posts structured webhook payloads to Zapier catch hooks. */
+declare const zapierChannelTransport: (opts: ZapierChannelTransportOptions) => Transport;
+//#endregion
+//#region src/transports/zapier.types.d.ts
+type ZapierTransportOptions = {
+  webhookUrl: string;
+  timeoutMs?: number;
+  logger?: LoggerLike;
+  http?: HttpClientBehaviorOptions;
+};
+//#endregion
+//#region src/transports/zapier.d.ts
+/** Email transport that posts rendered messages to a Zapier catch hook webhook. */
+declare const zapierTransport: (opts: ZapierTransportOptions) => _betternotify_email0.Transport;
+//#endregion
+//#region src/transports/mock.d.ts
+type MockZapierTransport = MockTransport<RenderedZapier, ZapierChannelTransportData> & {
+  readonly payloads: ReadonlyArray<RenderedZapier & {
+    id: string;
+  }>;
+};
+declare const mockZapierTransport: () => MockZapierTransport;
+//#endregion
+//#region src/is-retriable.d.ts
+declare const isZapierRetriable: (err: unknown) => boolean;
+//#endregion
+export { type DataResolver, type EventResolver, type MetaResolver, type MockZapierTransport, type RenderedZapier, type Transport, type ZapierChannelTransportData, type ZapierChannelTransportOptions, type ZapierEmailPayload, type ZapierSendArgs, type ZapierTransportOptions, type ZapierWebhookPayload, isZapierRetriable, mockZapierTransport, zapierChannel, zapierChannelTransport, zapierTransport };