npm - @solytude/listmonk - Versions diffs - 1.0.0 - Mend

@solytude/listmonk 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (108) hide show

package/LICENSE +21 -0
package/README.md +542 -0
package/dist/chunk-saezhne8.js +14 -0
package/dist/chunk-saezhne8.js.map +9 -0
package/dist/client.d.ts +430 -0
package/dist/errors/api.d.ts +178 -0
package/dist/errors/base.d.ts +47 -0
package/dist/errors/configuration.d.ts +49 -0
package/dist/errors/index.d.ts +13 -0
package/dist/errors/network.d.ts +69 -0
package/dist/errors/validation.d.ts +57 -0
package/dist/http/auth.d.ts +39 -0
package/dist/http/client.d.ts +149 -0
package/dist/http/hooks.d.ts +90 -0
package/dist/http/index.d.ts +10 -0
package/dist/http/resource.d.ts +100 -0
package/dist/http/sse.d.ts +36 -0
package/dist/http/url.d.ts +51 -0
package/dist/index.d.ts +64 -0
package/dist/index.js +16039 -0
package/dist/index.js.map +120 -0
package/dist/resources/admin/admin.d.ts +92 -0
package/dist/resources/admin/index.d.ts +10 -0
package/dist/resources/admin/schemas.d.ts +23 -0
package/dist/resources/admin/types.d.ts +29 -0
package/dist/resources/bounces/bounces.d.ts +262 -0
package/dist/resources/bounces/index.d.ts +10 -0
package/dist/resources/bounces/schemas.d.ts +86 -0
package/dist/resources/bounces/types.d.ts +37 -0
package/dist/resources/campaigns/campaigns.d.ts +339 -0
package/dist/resources/campaigns/index.d.ts +10 -0
package/dist/resources/campaigns/schemas.d.ts +374 -0
package/dist/resources/campaigns/types.d.ts +111 -0
package/dist/resources/dashboard/dashboard.d.ts +73 -0
package/dist/resources/dashboard/index.d.ts +10 -0
package/dist/resources/dashboard/schemas.d.ts +55 -0
package/dist/resources/dashboard/types.d.ts +22 -0
package/dist/resources/import/import.d.ts +215 -0
package/dist/resources/import/index.d.ts +10 -0
package/dist/resources/import/schemas.d.ts +109 -0
package/dist/resources/import/types.d.ts +72 -0
package/dist/resources/lists/index.d.ts +10 -0
package/dist/resources/lists/lists.d.ts +180 -0
package/dist/resources/lists/schemas.d.ts +176 -0
package/dist/resources/lists/types.d.ts +56 -0
package/dist/resources/maintenance/index.d.ts +10 -0
package/dist/resources/maintenance/maintenance.d.ts +92 -0
package/dist/resources/maintenance/schemas.d.ts +36 -0
package/dist/resources/maintenance/types.d.ts +31 -0
package/dist/resources/media/index.d.ts +10 -0
package/dist/resources/media/media.d.ts +198 -0
package/dist/resources/media/schemas.d.ts +48 -0
package/dist/resources/media/types.d.ts +48 -0
package/dist/resources/public/index.d.ts +10 -0
package/dist/resources/public/public.d.ts +111 -0
package/dist/resources/public/schemas.d.ts +52 -0
package/dist/resources/public/types.d.ts +30 -0
package/dist/resources/settings/index.d.ts +10 -0
package/dist/resources/settings/schemas.d.ts +374 -0
package/dist/resources/settings/settings.d.ts +106 -0
package/dist/resources/settings/types.d.ts +78 -0
package/dist/resources/subscribers/index.d.ts +10 -0
package/dist/resources/subscribers/schemas.d.ts +360 -0
package/dist/resources/subscribers/subscribers.d.ts +308 -0
package/dist/resources/subscribers/types.d.ts +113 -0
package/dist/resources/templates/index.d.ts +10 -0
package/dist/resources/templates/schemas.d.ts +110 -0
package/dist/resources/templates/templates.d.ts +225 -0
package/dist/resources/templates/types.d.ts +45 -0
package/dist/resources/tx/index.d.ts +10 -0
package/dist/resources/tx/schemas.d.ts +67 -0
package/dist/resources/tx/tx.d.ts +167 -0
package/dist/resources/tx/types.d.ts +88 -0
package/dist/schemas/common.d.ts +48 -0
package/dist/schemas/index.d.ts +6 -0
package/dist/testing/errors.d.ts +25 -0
package/dist/testing/factories/bounce.d.ts +43 -0
package/dist/testing/factories/campaign.d.ts +43 -0
package/dist/testing/factories/common.d.ts +54 -0
package/dist/testing/factories/index.d.ts +12 -0
package/dist/testing/factories/list.d.ts +43 -0
package/dist/testing/factories/media.d.ts +40 -0
package/dist/testing/factories/subscriber.d.ts +43 -0
package/dist/testing/factories/template.d.ts +40 -0
package/dist/testing/index.d.ts +39 -0
package/dist/testing/index.js +573 -0
package/dist/testing/index.js.map +32 -0
package/dist/testing/mock-client.d.ts +119 -0
package/dist/testing/mock-function.d.ts +28 -0
package/dist/testing/resources/admin.d.ts +20 -0
package/dist/testing/resources/bounces.d.ts +22 -0
package/dist/testing/resources/campaigns.d.ts +31 -0
package/dist/testing/resources/dashboard.d.ts +17 -0
package/dist/testing/resources/import.d.ts +19 -0
package/dist/testing/resources/index.d.ts +18 -0
package/dist/testing/resources/lists.d.ts +24 -0
package/dist/testing/resources/maintenance.d.ts +18 -0
package/dist/testing/resources/media.d.ts +21 -0
package/dist/testing/resources/public.d.ts +18 -0
package/dist/testing/resources/settings.d.ts +19 -0
package/dist/testing/resources/subscribers.d.ts +33 -0
package/dist/testing/resources/templates.d.ts +24 -0
package/dist/testing/resources/tx.d.ts +16 -0
package/dist/testing/types.d.ts +138 -0
package/dist/types/config.d.ts +59 -0
package/dist/types/index.d.ts +7 -0
package/dist/types/pagination.d.ts +37 -0
package/package.json +97 -0

package/dist/resources/templates/templates.d.ts ADDED Viewed

@@ -0,0 +1,225 @@
+/**
+ * Templates resource for managing email templates.
+ *
+ * @module resources/templates
+ */
+import { APIResource } from "../../http/resource";
+import type { Template, TemplatePreview, CreateTemplateRequest, UpdateTemplateRequest, ListTemplatesOptions, LivePreviewRequest } from "./types";
+import type { PagedAsyncIterableIterator } from "../../types/pagination";
+/**
+ * Resource for managing email templates in listmonk.
+ *
+ * Provides methods for CRUD operations, listing, preview generation,
+ * default template management, and bulk deletion.
+ *
+ * @example
+ * ```typescript
+ * // Access via client
+ * const template = await client.templates.create({
+ *   name: 'Newsletter Template',
+ *   body: '<html>{{ template "content" . }}</html>',
+ *   type: 'campaign',
+ * });
+ * ```
+ */
+export declare class TemplatesResource extends APIResource {
+    /**
+     * Creates a new template.
+     *
+     * @param data - Template data
+     * @returns The created template
+     *
+     * @example
+     * ```typescript
+     * // Create a campaign template
+     * const template = await client.templates.create({
+     *   name: 'Weekly Newsletter',
+     *   type: 'campaign',
+     *   body: `
+     *     <html>
+     *       <body>
+     *         <h1>{{ .Campaign.Name }}</h1>
+     *         {{ template "content" . }}
+     *         <p><a href="{{ .UnsubscribeURL }}">Unsubscribe</a></p>
+     *       </body>
+     *     </html>
+     *   `,
+     * });
+     *
+     * // Create a transactional template (requires subject)
+     * const txTemplate = await client.templates.create({
+     *   name: 'Order Confirmation',
+     *   type: 'tx',
+     *   subject: 'Your Order #{{ .Tx.Data.order_id }}',
+     *   body: '<html><body>Thank you for your order!</body></html>',
+     * });
+     * ```
+     */
+    create(data: CreateTemplateRequest): Promise<Template>;
+    /**
+     * Retrieves a template by ID.
+     *
+     * @param id - Template ID
+     * @returns The template
+     * @throws {ListmonkNotFoundError} If template not found
+     *
+     * @example
+     * ```typescript
+     * const template = await client.templates.retrieve(1);
+     * console.log(template.name, template.type);
+     * console.log(`Default: ${template.is_default}`);
+     * ```
+     */
+    retrieve(id: number): Promise<Template>;
+    /**
+     * Updates an existing template.
+     *
+     * All fields are optional - only provided fields are updated.
+     *
+     * @param id - Template ID
+     * @param data - Updated template data
+     * @returns The updated template
+     *
+     * @example
+     * ```typescript
+     * const updated = await client.templates.update(1, {
+     *   name: 'Updated Newsletter Template',
+     *   body: '<html><body>New content {{ template "content" . }}</body></html>',
+     * });
+     * ```
+     */
+    update(id: number, data: UpdateTemplateRequest): Promise<Template>;
+    /**
+     * Deletes a template by ID.
+     *
+     * Note: Templates referenced by active campaigns cannot be deleted.
+     *
+     * @param id - Template ID
+     * @throws {ListmonkNotFoundError} If template not found
+     * @throws {ListmonkApiError} If template is in use (409 Conflict)
+     *
+     * @example
+     * ```typescript
+     * await client.templates.remove(5);
+     * ```
+     */
+    remove(id: number): Promise<void>;
+    /**
+     * Lists all templates.
+     *
+     * Note: The listmonk templates API returns all templates at once
+     * without pagination.
+     *
+     * @param options - Query options
+     * @param options.no_body - Exclude body field from response
+     * @returns Array of templates
+     *
+     * @example
+     * ```typescript
+     * // List all templates
+     * const templates = await client.templates.list();
+     * console.log(`Found ${templates.length} templates`);
+     *
+     * // List without body content (lighter response)
+     * const lightTemplates = await client.templates.list({ no_body: true });
+     * for (const template of lightTemplates) {
+     *   console.log(`${template.name} (${template.type})`);
+     * }
+     * ```
+     */
+    list(options?: ListTemplatesOptions): Promise<Template[]>;
+    /**
+     * Returns an async iterator over all templates.
+     *
+     * Note: Since the templates API doesn't support pagination, this
+     * iterator yields all templates in a single batch. The `byPage()`
+     * method yields a single "page" containing all templates.
+     *
+     * This method is provided for API consistency with other resources.
+     *
+     * @param options - Query options
+     * @returns Async iterator over templates
+     *
+     * @example
+     * ```typescript
+     * // Iterate over all templates
+     * for await (const template of client.templates.listAll()) {
+     *   console.log(template.name);
+     * }
+     *
+     * // Iterate by "page" (single page for templates)
+     * for await (const templates of client.templates.listAll().byPage()) {
+     *   console.log(`Templates in batch: ${templates.length}`);
+     * }
+     * ```
+     */
+    listAll(options?: ListTemplatesOptions): PagedAsyncIterableIterator<Template, Template[]>;
+    /**
+     * Generates a preview of a template.
+     *
+     * @param id - Template ID for stored template preview
+     * @returns The preview response with rendered HTML
+     *
+     * @example
+     * ```typescript
+     * // Preview a stored template
+     * const preview = await client.templates.preview(1);
+     * console.log(preview.body);
+     * ```
+     */
+    preview(id: number): Promise<TemplatePreview>;
+    /**
+     * Generates a live preview from template content.
+     *
+     * @param id - Must be null for live preview
+     * @param options - Live preview options
+     * @returns The preview response with rendered HTML
+     *
+     * @example
+     * ```typescript
+     * // Live preview (without saving)
+     * const livePreview = await client.templates.preview(null, {
+     *   template_type: 'campaign',
+     *   body: '<html>{{ template "content" . }}</html>',
+     * });
+     * console.log(livePreview.body);
+     * ```
+     */
+    preview(id: null, options: LivePreviewRequest): Promise<TemplatePreview>;
+    /**
+     * Sets a template as the default template for new campaigns.
+     *
+     * Note: Only one template can be the default at a time.
+     * Setting a new default automatically removes the previous default.
+     *
+     * @param id - Template ID
+     * @returns The updated template with is_default: true
+     *
+     * @example
+     * ```typescript
+     * const defaultTemplate = await client.templates.setDefault(2);
+     * console.log(`${defaultTemplate.name} is now the default template`);
+     *
+     * // Find current default
+     * const templates = await client.templates.list();
+     * const currentDefault = templates.find(t => t.is_default);
+     * ```
+     */
+    setDefault(id: number): Promise<Template>;
+    /**
+     * Deletes multiple templates by ID.
+     *
+     * Note: The listmonk API does not support bulk template deletion,
+     * so this method deletes templates sequentially. If any deletion
+     * fails (e.g., template is in use), the error is thrown immediately
+     * and remaining templates are not deleted.
+     *
+     * @param ids - Template IDs to delete
+     *
+     * @example
+     * ```typescript
+     * await client.templates.deleteMany([3, 4, 5]);
+     * ```
+     */
+    deleteMany(ids: number[]): Promise<void>;
+}

package/dist/resources/templates/types.d.ts ADDED Viewed

@@ -0,0 +1,45 @@
+/**
+ * TypeScript types for templates module.
+ *
+ * All types are inferred from Zod schemas to ensure runtime
+ * validation matches compile-time types.
+ *
+ * @module resources/templates/types
+ */
+import type { z } from "zod";
+import type { TemplateTypeSchema, TemplateSchema, TemplatePreviewSchema, CreateTemplateRequestSchema, UpdateTemplateRequestSchema, ListTemplatesOptionsSchema, LivePreviewRequestSchema, ListTemplatesResponseSchema } from "./schemas";
+/**
+ * Template type.
+ * - `campaign`: Standard campaign email templates
+ * - `campaign_visual`: Visual drag-and-drop editor templates
+ * - `tx`: Transactional email templates
+ */
+export type TemplateType = z.infer<typeof TemplateTypeSchema>;
+/**
+ * Complete template entity.
+ */
+export type Template = z.infer<typeof TemplateSchema>;
+/**
+ * Template preview response.
+ */
+export type TemplatePreview = z.infer<typeof TemplatePreviewSchema>;
+/**
+ * Request to create a new template (input type).
+ */
+export type CreateTemplateRequest = z.input<typeof CreateTemplateRequestSchema>;
+/**
+ * Request to update an existing template (input type).
+ */
+export type UpdateTemplateRequest = z.input<typeof UpdateTemplateRequestSchema>;
+/**
+ * Options for listing templates (input type).
+ */
+export type ListTemplatesOptions = z.input<typeof ListTemplatesOptionsSchema>;
+/**
+ * Request for live template preview (input type).
+ */
+export type LivePreviewRequest = z.input<typeof LivePreviewRequestSchema>;
+/**
+ * Response for listing all templates.
+ */
+export type ListTemplatesResponse = z.infer<typeof ListTemplatesResponseSchema>;

package/dist/resources/tx/index.d.ts ADDED Viewed

@@ -0,0 +1,10 @@
+/**
+ * Transactional resource module.
+ *
+ * Provides transactional email sending capabilities for the listmonk API.
+ *
+ * @module resources/tx
+ */
+export { TransactionalResource } from "./tx";
+export type { SubscriberMode, TransactionalContentType, TransactionalAttachment, TransactionalRequest, SendTransactionalRequestInput, } from "./types";
+export { SubscriberModeSchema, TransactionalContentTypeSchema, SendTransactionalRequestSchema, TransactionalResponseSchema, } from "./schemas";

package/dist/resources/tx/schemas.d.ts ADDED Viewed

@@ -0,0 +1,67 @@
+/**
+ * Zod schemas for transactional module requests and responses.
+ *
+ * @module resources/tx/schemas
+ */
+import { z } from "zod";
+/**
+ * Subscriber resolution mode for transactional messages.
+ *
+ * - `default`: Recipients MUST exist in subscriber database
+ * - `fallback`: Attempt lookup, send anyway if not found
+ * - `external`: No database lookup, send to any email
+ */
+export declare const SubscriberModeSchema: z.ZodEnum<{
+    default: "default";
+    external: "external";
+    fallback: "fallback";
+}>;
+/**
+ * Content type for transactional messages.
+ *
+ * - `html`: HTML content (default)
+ * - `markdown`: Markdown rendered to HTML
+ * - `plain`: Plain text
+ */
+export declare const TransactionalContentTypeSchema: z.ZodEnum<{
+    html: "html";
+    markdown: "markdown";
+    plain: "plain";
+}>;
+/**
+ * Request schema for sending transactional messages.
+ *
+ * Validates that:
+ * - template_id is a positive integer (required)
+ * - At least one recipient is provided
+ * - Email addresses are valid format
+ * - Subscriber IDs are positive integers
+ */
+export declare const SendTransactionalRequestSchema: z.ZodObject<{
+    template_id: z.ZodNumber;
+    subscriber_email: z.ZodOptional<z.ZodString>;
+    subscriber_id: z.ZodOptional<z.ZodNumber>;
+    subscriber_emails: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    subscriber_ids: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    subscriber_mode: z.ZodOptional<z.ZodEnum<{
+        default: "default";
+        external: "external";
+        fallback: "fallback";
+    }>>;
+    from_email: z.ZodOptional<z.ZodString>;
+    subject: z.ZodOptional<z.ZodString>;
+    data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    headers: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodString>>>;
+    content_type: z.ZodOptional<z.ZodEnum<{
+        html: "html";
+        markdown: "markdown";
+        plain: "plain";
+    }>>;
+    messenger: z.ZodOptional<z.ZodString>;
+    attachments: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+}, z.core.$strip>;
+/**
+ * Response schema for transactional send.
+ * The API returns { data: true } on success.
+ */
+export declare const TransactionalResponseSchema: z.ZodBoolean;

package/dist/resources/tx/tx.d.ts ADDED Viewed

@@ -0,0 +1,167 @@
+/**
+ * Transactional resource for sending application-triggered emails.
+ *
+ * @module resources/tx
+ */
+import { APIResource } from "../../http/resource";
+import type { TransactionalRequest } from "./types";
+/**
+ * Resource for sending transactional messages via listmonk.
+ *
+ * Transactional messages are application-triggered emails like welcome emails,
+ * order confirmations, password resets, and other automated communications.
+ *
+ * @example
+ * ```typescript
+ * // Send to an existing subscriber
+ * await client.tx.send({
+ *   template_id: 2,
+ *   subscriber_email: 'user@example.com',
+ * });
+ *
+ * // Send with template data
+ * await client.tx.send({
+ *   template_id: 2,
+ *   subscriber_email: 'user@example.com',
+ *   data: {
+ *     order_id: '12345',
+ *     total: '$99.99',
+ *   },
+ * });
+ *
+ * // Send to external recipient (not in subscriber database)
+ * await client.tx.send({
+ *   template_id: 2,
+ *   subscriber_mode: 'external',
+ *   subscriber_emails: ['guest@example.com'],
+ *   data: { name: 'Guest User' },
+ * });
+ * ```
+ */
+export declare class TransactionalResource extends APIResource {
+    /**
+     * Sends a transactional message.
+     *
+     * @param request - The transactional message request
+     * @returns `true` on success
+     * @throws {ListmonkValidationError} If request validation fails
+     * @throws {ListmonkNotFoundError} If template not found
+     * @throws {ListmonkApiError} If subscriber not found (default mode), messenger not configured, etc.
+     *
+     * @example Send to a subscriber by email
+     * ```typescript
+     * await client.tx.send({
+     *   template_id: 2,
+     *   subscriber_email: 'user@example.com',
+     * });
+     * ```
+     *
+     * @example Send to a subscriber by ID
+     * ```typescript
+     * await client.tx.send({
+     *   template_id: 2,
+     *   subscriber_id: 123,
+     * });
+     * ```
+     *
+     * @example Send to multiple subscribers
+     * ```typescript
+     * await client.tx.send({
+     *   template_id: 2,
+     *   subscriber_emails: ['user1@example.com', 'user2@example.com'],
+     * });
+     * ```
+     *
+     * @example Send with template variables
+     * ```typescript
+     * // Variables are accessible via {{ .Tx.Data.* }} in the template
+     * await client.tx.send({
+     *   template_id: 2,
+     *   subscriber_email: 'user@example.com',
+     *   data: {
+     *     order_id: '12345',
+     *     total: '$99.99',
+     *     items: ['Product A', 'Product B'],
+     *   },
+     * });
+     * ```
+     *
+     * @example Send to external recipient (not in subscriber database)
+     * ```typescript
+     * await client.tx.send({
+     *   template_id: 2,
+     *   subscriber_mode: 'external',
+     *   subscriber_emails: ['guest@example.com'],
+     *   data: { name: 'Guest User' },
+     * });
+     * ```
+     *
+     * @example Send with fallback mode (try lookup, send anyway if not found)
+     * ```typescript
+     * await client.tx.send({
+     *   template_id: 2,
+     *   subscriber_mode: 'fallback',
+     *   subscriber_emails: ['maybe-subscriber@example.com'],
+     * });
+     * ```
+     *
+     * @example Customize message properties
+     * ```typescript
+     * await client.tx.send({
+     *   template_id: 2,
+     *   subscriber_email: 'user@example.com',
+     *   subject: 'Urgent: Your Order Has Shipped!',
+     *   from_email: 'shipping@example.com',
+     *   content_type: 'html',
+     *   headers: [
+     *     { 'X-Priority': '1' },
+     *     { 'X-Campaign-ID': 'order-confirmation' },
+     *   ],
+     * });
+     * ```
+     *
+     * @example Send with file attachments (Browser)
+     * ```typescript
+     * const file = new File([pdfContent], 'invoice.pdf', { type: 'application/pdf' });
+     * await client.tx.send({
+     *   template_id: 2,
+     *   subscriber_email: 'user@example.com',
+     *   attachments: [file],
+     * });
+     * ```
+     *
+     * @example Send with file attachments (Node.js)
+     * ```typescript
+     * import { readFileSync } from 'fs';
+     * await client.tx.send({
+     *   template_id: 2,
+     *   subscriber_email: 'user@example.com',
+     *   attachments: [
+     *     { filename: 'invoice.pdf', content: readFileSync('./invoice.pdf') },
+     *   ],
+     * });
+     * ```
+     *
+     * @example Send via alternative messenger
+     * ```typescript
+     * await client.tx.send({
+     *   template_id: 2,
+     *   subscriber_email: 'user@example.com',
+     *   messenger: 'sms',
+     * });
+     * ```
+     */
+    send(request: TransactionalRequest): Promise<boolean>;
+    /**
+     * Sends a transactional message with file attachments using multipart/form-data.
+     *
+     * @internal
+     */
+    private sendWithAttachments;
+    /**
+     * Converts a TransactionalAttachment to a Blob suitable for FormData.
+     *
+     * @internal
+     */
+    private toFormDataFile;
+}

package/dist/resources/tx/types.d.ts ADDED Viewed

@@ -0,0 +1,88 @@
+/**
+ * TypeScript types for transactional module.
+ *
+ * All types are inferred from Zod schemas to ensure runtime
+ * validation matches compile-time types.
+ *
+ * @module resources/tx/types
+ */
+import type { z } from "zod";
+import type { SubscriberModeSchema, TransactionalContentTypeSchema, SendTransactionalRequestSchema } from "./schemas";
+/**
+ * Subscriber resolution mode for transactional messages.
+ *
+ * - `default`: Recipients MUST exist in subscriber database
+ * - `fallback`: Attempt lookup, send anyway if not found
+ * - `external`: No database lookup, send to any email
+ */
+export type SubscriberMode = z.infer<typeof SubscriberModeSchema>;
+/**
+ * Content type for transactional messages.
+ *
+ * - `html`: HTML content (default)
+ * - `markdown`: Markdown rendered to HTML
+ * - `plain`: Plain text
+ */
+export type TransactionalContentType = z.infer<typeof TransactionalContentTypeSchema>;
+/**
+ * Attachment type for transactional messages.
+ *
+ * Supports multiple patterns for cross-runtime compatibility:
+ * - `File`: Web API File (browser, Node 20+, Bun, Deno)
+ * - `Blob`: Web API Blob (browser, Node 22+, Bun, Deno)
+ * - Object with filename and content: Node.js Buffer/Uint8Array pattern
+ *
+ * @example Browser (File API)
+ * ```typescript
+ * const file = new File([pdfContent], 'invoice.pdf', { type: 'application/pdf' });
+ * await client.tx.send({ template_id: 1, subscriber_email: '...', attachments: [file] });
+ * ```
+ *
+ * @example Node.js (Buffer pattern)
+ * ```typescript
+ * import { readFileSync } from 'fs';
+ * const attachment = { filename: 'invoice.pdf', content: readFileSync('./invoice.pdf') };
+ * await client.tx.send({ template_id: 1, subscriber_email: '...', attachments: [attachment] });
+ * ```
+ */
+export type TransactionalAttachment = File | Blob | {
+    filename: string;
+    content: Buffer | Uint8Array;
+};
+/**
+ * Input type for sending a transactional message.
+ *
+ * This is the user-facing input type that accepts TransactionalAttachment[].
+ */
+export interface TransactionalRequest {
+    /** ID of the transactional template to use (required) */
+    template_id: number;
+    /** Single recipient email address */
+    subscriber_email?: string;
+    /** Single recipient subscriber ID */
+    subscriber_id?: number;
+    /** Multiple recipient email addresses */
+    subscriber_emails?: string[];
+    /** Multiple recipient subscriber IDs */
+    subscriber_ids?: number[];
+    /** How to resolve recipients in the subscriber database */
+    subscriber_mode?: SubscriberMode;
+    /** Override sender email address */
+    from_email?: string;
+    /** Override template subject line */
+    subject?: string;
+    /** Template variables accessible via {{ .Tx.Data.* }} */
+    data?: Record<string, unknown>;
+    /** Custom email headers */
+    headers?: Array<Record<string, string>>;
+    /** Message content type */
+    content_type?: TransactionalContentType;
+    /** Delivery channel (default: "email") */
+    messenger?: string;
+    /** File attachments */
+    attachments?: TransactionalAttachment[];
+}
+/**
+ * Internal type inferred from the Zod schema (for validation).
+ */
+export type SendTransactionalRequestInput = z.input<typeof SendTransactionalRequestSchema>;

package/dist/schemas/common.d.ts ADDED Viewed

@@ -0,0 +1,48 @@
+/**
+ * Shared Zod schemas used across multiple resource modules.
+ *
+ * These schemas represent common validation patterns that are duplicated
+ * across the codebase. Centralizing them ensures consistency and provides
+ * a single source of truth.
+ *
+ * @module schemas/common
+ */
+import { z } from "zod";
+/**
+ * Validates a positive integer ID.
+ *
+ * Used for entity IDs throughout the API (subscriber_id, list_id, etc.).
+ */
+export declare const PositiveIdSchema: z.ZodNumber;
+/**
+ * Validates an array of positive integer IDs for bulk operations.
+ *
+ * Used by bulk delete endpoints across subscribers, lists, campaigns, bounces.
+ */
+export declare const BulkDeleteIdsSchema: z.ZodArray<z.ZodNumber>;
+/**
+ * Response schema for delete and similar operations that return `true`.
+ *
+ * The listmonk API returns `{ data: true }` for successful delete operations.
+ * The HttpClient unwraps this to just `true`.
+ */
+export declare const DeleteResponseSchema: z.ZodLiteral<true>;
+/**
+ * Bounce type classification.
+ *
+ * - `hard`: Permanent delivery failure (invalid address, domain doesn't exist)
+ * - `soft`: Temporary delivery failure (mailbox full, server unavailable)
+ */
+export declare const BounceTypeSchema: z.ZodEnum<{
+    hard: "hard";
+    soft: "soft";
+}>;
+/**
+ * Embedded campaign reference within a bounce record.
+ *
+ * Used by both subscribers (for bounce history) and bounces modules.
+ */
+export declare const BounceCampaignSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    name: z.ZodString;
+}, z.core.$strip>;

package/dist/schemas/index.d.ts ADDED Viewed

@@ -0,0 +1,6 @@
+/**
+ * Shared schema exports.
+ *
+ * @module schemas
+ */
+export { PositiveIdSchema, BulkDeleteIdsSchema, DeleteResponseSchema, BounceTypeSchema, BounceCampaignSchema, } from "./common";

package/dist/testing/errors.d.ts ADDED Viewed

@@ -0,0 +1,25 @@
+/**
+ * Error thrown when an unconfigured mock function is called.
+ *
+ * @example
+ * ```typescript
+ * const mockClient = new MockListmonkClient();
+ *
+ * // This throws MockNotConfiguredError
+ * await mockClient.subscribers.get(1);
+ * // Error: Mock method 'subscribers.get' was called but not configured.
+ * // Configure with: mockClient.subscribers.get.mockResolvedValue(...)
+ * ```
+ */
+export declare class MockNotConfiguredError extends Error {
+    readonly name: "MockNotConfiguredError";
+    /**
+     * The name of the method that was called without configuration.
+     */
+    readonly methodName: string;
+    /**
+     * The resource name (e.g., 'subscribers', 'campaigns').
+     */
+    readonly resourceName: string;
+    constructor(resourceName: string, methodName: string);
+}