@maloma/listmonk 1.0.0 → 1.0.1

package/dist/testing/index.js

@@ -1,5 +1,3 @@
-import"../chunk-saezhne8.js";
-
 // src/testing/errors.ts
 class MockNotConfiguredError extends Error {
   name = "MockNotConfiguredError";
@@ -34,7 +32,7 @@ function createMockFunction(resourceName, methodName) {
       throw error;
     }
     try {
-      const result = implementation(...args);
+      const result = implementation?.(...args);
       if (result instanceof Promise) {
         return result.then((value) => {
           state.results.push({
@@ -569,5 +567,3 @@ export {
   MockNotConfiguredError,
   MockListmonkClient
 };
-
-//# debugId=367CDA81B275C35364756E2164756E21

package/package.json

@@ -1,9 +1,27 @@
 {
 	"name": "@maloma/listmonk",
-	"version": "1.0.0",
-	"description": "Production-grade TypeScript SDK for the listmonk email marketing platform API",
-	"author": "maloma",
+	"version": "1.0.1",
+	"description": "TypeScript SDK for the listmonk email marketing platform API",
+	"keywords": [
+		"listmonk",
+		"email",
+		"newsletter",
+		"mailing list",
+		"typescript",
+		"sdk",
+		"api",
+		"email marketing"
+	],
+	"homepage": "https://maloma.org/projects/listmonk-sdk",
+	"bugs": {
+		"url": "https://codeberg.org/maloma/listmonk-sdk/issues"
+	},
+	"repository": {
+		"url": "https://codeberg.org/maloma/listmonk-sdk.git"
+	},
 	"license": "MIT",
+	"author": "maloma",
+	"sideEffects": false,
 	"type": "module",
 	"exports": {
 		".": {
@@ -30,68 +48,29 @@
 		"README.md",
 		"LICENSE"
 	],
-	"sideEffects": false,
-	"packageManager": "bun@1.3.5",
-	"engines": {
-		"bun": ">=1.3.0",
-		"node": ">=22.0.0"
-	},
-	"keywords": [
-		"listmonk",
-		"email",
-		"newsletter",
-		"mailing list",
-		"typescript",
-		"sdk",
-		"api",
-		"email marketing"
-	],
-	"homepage": "https://maloma.org/projects/listmonk-sdk",
-	"bugs": {
-		"url": "https://codeberg.org/maloma/listmonk-sdk/issues"
-	},
-	"repository": {
-		"type": "git",
-		"url": "https://codeberg.org/maloma/listmonk-sdk.git"
-	},
 	"scripts": {
-		"build": "bun run build:js && bun run build:types",
-		"build:js": "bun run scripts/build.ts",
-		"build:types": "tsc -p tsconfig.build.json",
-		"test": "bun test tests/",
-		"test:unit": "bun test tests/unit/",
-		"test:integration": "bun test tests/integration/",
-		"test:e2e": "bun test tests/e2e/",
-		"check": "biome check",
-		"lint": "biome lint --write",
-		"format": "biome format --write",
-		"typecheck": "tsc -p tsconfig.check.json",
-		"docs": "typedoc",
-		"prepublishOnly": "bun run build && bun test tests/unit/ tests/integration/"
+		"build": "bunup src/index.ts src/testing/index.ts --dts.infer-types",
+		"test": "bun test tests/unit/ tests/integration/",
+		"lint": "biome check",
+		"lint:fix": "biome check --write",
+		"typecheck": "tsc --noEmit",
+		"prepublishOnly": "bun run build && bun run test"
 	},
 	"dependencies": {
-		"zod": "^4.3.5"
-	},
-	"publishConfig": {
-		"access": "public",
-		"registry": "https://registry.npmjs.org"
-	},
-	"overrides": {
-		"got": "11.8.5"
+		"zod": "^4.3.6"
 	},
 	"devDependencies": {
-		"@biomejs/biome": "2.3.11",
 		"@bun-security-scanner/osv": "^1.0.0",
-		"@commitlint/cli": "^20.3.0",
-		"@commitlint/config-conventional": "^20.3.0",
-		"@saithodev/semantic-release-gitea": "^2.0.0",
-		"@semantic-release/changelog": "^6.0.0",
-		"@semantic-release/git": "^10.0.0",
-		"@tsconfig/bun": "^1.0.10",
-		"@types/bun": "^1.3.5",
-		"semantic-release": "^25.0.0",
-		"typedoc": "^0.28.15",
-		"typedoc-plugin-markdown": "^4.0.0",
+		"@types/bun": "^1.3.6",
+		"bunup": "^0.16.20",
 		"typescript": "^5.9.3"
+	},
+	"packageManager": "bun@1.3.6",
+	"engines": {
+		"bun": ">=1.3.0",
+		"node": ">=22.0.0"
+	},
+	"publishConfig": {
+		"access": "public"
 	}
 }

package/dist/chunk-saezhne8.js

@@ -1,14 +0,0 @@
-var __defProp = Object.defineProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, {
-      get: all[name],
-      enumerable: true,
-      configurable: true,
-      set: (newValue) => all[name] = () => newValue
-    });
-};
-
-export { __export };
-
-//# debugId=934851CB66A4F95F64756E2164756E21

package/dist/chunk-saezhne8.js.map

@@ -1,9 +0,0 @@
-{
-  "version": 3,
-  "sources": [],
-  "sourcesContent": [
-  ],
-  "mappings": "",
-  "debugId": "934851CB66A4F95F64756E2164756E21",
-  "names": []
-}

package/dist/client.d.ts

@@ -1,430 +0,0 @@
-/**
- * Main Listmonk client class.
- *
- * The primary entry point for the SDK. Validates configuration,
- * creates the HTTP client, and provides access to resource modules.
- *
- * @module client
- */
-import { HttpClient } from "./http/client";
-import type { ClientOptionsInput } from "./types/config";
-import { SubscribersResource } from "./resources/subscribers";
-import { ListsResource } from "./resources/lists";
-import { CampaignsResource } from "./resources/campaigns";
-import { TemplatesResource } from "./resources/templates";
-import { TransactionalResource } from "./resources/tx";
-import { MediaResource } from "./resources/media";
-import { ImportResource } from "./resources/import";
-import { BouncesResource } from "./resources/bounces";
-import { SettingsResource } from "./resources/settings";
-import { DashboardResource } from "./resources/dashboard";
-import { AdminResource } from "./resources/admin";
-import { MaintenanceResource } from "./resources/maintenance";
-import { PublicResource } from "./resources/public";
-import type { ServerHealth, ServerConfig } from "./resources/settings/types";
-/**
- * Listmonk SDK client for interacting with the listmonk API.
- *
- * @example
- * ```typescript
- * import { Listmonk } from '@maloma/listmonk';
- *
- * const client = new Listmonk({
- *   url: 'https://listmonk.example.com',
- *   auth: {
- *     username: 'admin',
- *     password: 'secret',
- *   },
- * });
- *
- * // Use resource modules (to be added in subsequent specs)
- * // const subscribers = await client.subscribers.list();
- * ```
- */
-export declare class Listmonk {
-    /** @internal The underlying HTTP client */
-    private readonly _httpClient;
-    /**
-     * Subscribers resource for managing subscriber lifecycle.
-     *
-     * @example
-     * ```typescript
-     * // Create a subscriber
-     * const subscriber = await client.subscribers.create({
-     *   email: 'john@example.com',
-     *   name: 'John Doe',
-     *   status: 'enabled',
-     * });
-     *
-     * // List subscribers
-     * for await (const sub of client.subscribers.listAll()) {
-     *   console.log(sub.email);
-     * }
-     * ```
-     */
-    readonly subscribers: SubscribersResource;
-    /**
-     * Lists resource for managing mailing lists.
-     *
-     * @example
-     * ```typescript
-     * // Create a list
-     * const list = await client.lists.create({
-     *   name: 'Newsletter',
-     *   type: 'public',
-     *   optin: 'double',
-     * });
-     *
-     * // List all lists
-     * for await (const l of client.lists.listAll()) {
-     *   console.log(l.name);
-     * }
-     * ```
-     */
-    readonly lists: ListsResource;
-    /**
-     * Campaigns resource for managing email campaigns.
-     *
-     * @example
-     * ```typescript
-     * // Create a campaign
-     * const campaign = await client.campaigns.create({
-     *   name: 'Weekly Newsletter',
-     *   subject: 'This Week in Tech',
-     *   lists: [1],
-     *   body: '<h1>Hello!</h1>',
-     *   content_type: 'html',
-     * });
-     *
-     * // Start the campaign
-     * await client.campaigns.updateStatus(campaign.id, 'running');
-     *
-     * // List all campaigns
-     * for await (const c of client.campaigns.listAll()) {
-     *   console.log(c.name, c.status);
-     * }
-     * ```
-     */
-    readonly campaigns: CampaignsResource;
-    /**
-     * Templates resource for managing email templates.
-     *
-     * @example
-     * ```typescript
-     * // Create a template
-     * const template = await client.templates.create({
-     *   name: 'Newsletter Template',
-     *   type: 'campaign',
-     *   body: '<html>{{ template "content" . }}</html>',
-     * });
-     *
-     * // List all templates
-     * for await (const t of client.templates.listAll()) {
-     *   console.log(t.name, t.is_default);
-     * }
-     *
-     * // Set as default
-     * await client.templates.setDefault(template.id);
-     * ```
-     */
-    readonly templates: TemplatesResource;
-    /**
-     * Transactional resource for sending application-triggered emails.
-     *
-     * @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
-     * await client.tx.send({
-     *   template_id: 2,
-     *   subscriber_mode: 'external',
-     *   subscriber_emails: ['guest@example.com'],
-     * });
-     *
-     * // Send with file attachment
-     * await client.tx.send({
-     *   template_id: 2,
-     *   subscriber_email: 'user@example.com',
-     *   attachments: [
-     *     { filename: 'invoice.pdf', content: pdfBuffer },
-     *   ],
-     * });
-     * ```
-     */
-    readonly tx: TransactionalResource;
-    /**
-     * Media resource for managing media files (images, PDFs, etc.).
-     *
-     * @example
-     * ```typescript
-     * // Upload a file (Browser)
-     * const file = new File([content], 'hero.jpg', { type: 'image/jpeg' });
-     * const media = await client.media.upload(file);
-     * console.log(`URL: ${media.url}`);
-     *
-     * // Upload a file (Node.js)
-     * import { readFileSync } from 'fs';
-     * const media = await client.media.upload({
-     *   filename: 'hero.jpg',
-     *   content: readFileSync('./hero.jpg'),
-     * });
-     *
-     * // List all media
-     * const allMedia = await client.media.list();
-     *
-     * // Delete media
-     * const deleted = await client.media.remove(42);
-     * ```
-     */
-    readonly media: MediaResource;
-    /**
-     * Import resource for bulk subscriber import from CSV/ZIP files.
-     *
-     * @example
-     * ```typescript
-     * // Start import (Browser)
-     * const file = new File([csvContent], 'subscribers.csv');
-     * await client.import.start(file, {
-     *   mode: 'subscribe',
-     *   delimiter: ',',
-     *   lists: [1, 2],
-     * });
-     *
-     * // Start import (Node.js)
-     * import { readFileSync } from 'fs';
-     * await client.import.start(
-     *   { filename: 'subscribers.csv', content: readFileSync('./subscribers.csv') },
-     *   { mode: 'subscribe', delimiter: ',', lists: [1] }
-     * );
-     *
-     * // Poll for completion
-     * let status = await client.import.getStatus();
-     * while (status.status === 'processing') {
-     *   await new Promise(r => setTimeout(r, 1000));
-     *   status = await client.import.getStatus();
-     * }
-     *
-     * // Check logs
-     * const logs = await client.import.getLogs();
-     *
-     * // Cancel if needed
-     * await client.import.cancel();
-     * ```
-     */
-    readonly import: ImportResource;
-    /**
-     * Bounces resource for managing email bounce records.
-     *
-     * @example
-     * ```typescript
-     * // List bounces with filtering
-     * const bounces = await client.bounces.list({
-     *   campaign_id: 5,
-     *   order_by: 'created_at',
-     *   order: 'desc',
-     * });
-     *
-     * // Iterate all bounces
-     * for await (const bounce of client.bounces.listAll()) {
-     *   if (bounce.type === 'hard') {
-     *     console.log(`Hard bounce: ${bounce.email}`);
-     *   }
-     * }
-     *
-     * // Delete a specific bounce
-     * await client.bounces.remove(123);
-     *
-     * // Blocklist all bounced subscribers
-     * await client.bounces.blocklistBounced();
-     * ```
-     */
-    readonly bounces: BouncesResource;
-    /**
-     * Settings resource for managing server settings.
-     *
-     * @example
-     * ```typescript
-     * // Get all settings
-     * const settings = await client.settings.getAll();
-     * console.log(settings['app.site_name']);
-     *
-     * // Update settings
-     * const result = await client.settings.update({
-     *   'app.site_name': 'My Newsletter',
-     *   ...settings,
-     * });
-     *
-     * // Test SMTP configuration
-     * const logs = await client.settings.testSmtp({
-     *   host: 'smtp.example.com',
-     *   port: 587,
-     *   auth_protocol: 'login',
-     *   username: 'user',
-     *   password: 'pass',
-     *   tls_type: 'STARTTLS',
-     *   email: 'test@example.com',
-     * });
-     * ```
-     */
-    readonly settings: SettingsResource;
-    /**
-     * Dashboard resource for retrieving statistics.
-     *
-     * @example
-     * ```typescript
-     * // Get dashboard counts
-     * const counts = await client.dashboard.getCounts();
-     * console.log(`Total subscribers: ${counts.subscribers.total}`);
-     *
-     * // Get chart data
-     * const charts = await client.dashboard.getCharts();
-     * for (const point of charts.link_clicks) {
-     *   console.log(`${point.date}: ${point.count} clicks`);
-     * }
-     * ```
-     */
-    readonly dashboard: DashboardResource;
-    /**
-     * Admin resource for server administration.
-     *
-     * @example
-     * ```typescript
-     * // Reload application
-     * await client.admin.reload();
-     *
-     * // Get logs
-     * const logs = await client.admin.getLogs();
-     *
-     * // Stream events
-     * for await (const event of client.admin.getEventStream()) {
-     *   console.log(event.type, event.message);
-     * }
-     * ```
-     */
-    readonly admin: AdminResource;
-    /**
-     * Maintenance resource for cleanup operations.
-     *
-     * @example
-     * ```typescript
-     * // Delete blocklisted subscribers
-     * const result = await client.maintenance.gcSubscribers('blocklisted');
-     * console.log(`Deleted ${result.count} subscribers`);
-     *
-     * // Delete old analytics
-     * await client.maintenance.gcAnalytics('all', '2025-01-01T00:00:00Z');
-     * ```
-     */
-    readonly maintenance: MaintenanceResource;
-    /**
-     * Public resource for unauthenticated endpoints.
-     *
-     * @example
-     * ```typescript
-     * // Get public lists
-     * const lists = await client.public.getLists();
-     *
-     * // Submit subscription
-     * const result = await client.public.subscribe({
-     *   email: 'user@example.com',
-     *   list_uuids: [lists[0].uuid],
-     * });
-     *
-     * // Get CAPTCHA challenge
-     * const challenge = await client.public.getCaptchaChallenge();
-     * ```
-     */
-    readonly public: PublicResource;
-    /**
-     * Creates a new Listmonk client.
-     *
-     * @param options - Client configuration options
-     * @throws {ListmonkConfigurationError} If options are invalid
-     *
-     * @example
-     * ```typescript
-     * const client = new Listmonk({
-     *   url: 'https://listmonk.example.com',
-     *   auth: { username: 'admin', password: 'secret' },
-     *   timeout: 60_000,  // Optional, default 30s
-     *   maxRetries: 5,    // Optional, default 3
-     *   debug: true,      // Optional, default false
-     * });
-     * ```
-     */
-    constructor(options: ClientOptionsInput);
-    /**
-     * Gets the underlying HTTP client.
-     * For internal use by resource modules.
-     * @internal
-     */
-    get httpClient(): HttpClient;
-    /**
-     * Checks server health (authenticated endpoint).
-     *
-     * Returns `true` if the server is healthy and reachable.
-     * Throws an error on network failure or authentication issues.
-     *
-     * @returns `true` if server is healthy
-     * @throws {ListmonkApiError} On API errors
-     * @throws {ListmonkNetworkError} On network failures
-     *
-     * @example
-     * ```typescript
-     * const healthy = await client.health();
-     * console.log(`Server healthy: ${healthy}`); // true
-     * ```
-     */
-    health(): Promise<ServerHealth>;
-    /**
-     * Checks server health (public endpoint, no authentication).
-     *
-     * Useful for health checks before authentication is configured
-     * or for public monitoring systems.
-     *
-     * @returns `true` if server is healthy
-     * @throws {ListmonkNetworkError} On network failures
-     *
-     * @example
-     * ```typescript
-     * const healthy = await client.publicHealth();
-     * console.log(`Server reachable: ${healthy}`); // true
-     * ```
-     */
-    publicHealth(): Promise<ServerHealth>;
-    /**
-     * Retrieves server configuration and capabilities.
-     *
-     * Returns information about the server version, enabled features,
-     * available updates, and runtime configuration.
-     *
-     * @returns Server configuration object
-     *
-     * @example
-     * ```typescript
-     * const config = await client.getConfig();
-     * console.log(`Version: ${config.version}`);
-     * console.log(`Needs restart: ${config.needs_restart}`);
-     *
-     * if (config.update?.is_new) {
-     *   console.log(`Update available: ${config.update.release_version}`);
-     * }
-     * ```
-     */
-    getConfig(): Promise<ServerConfig>;
-}