Add constructor type and require baseUrl

Author: gmethvin

package.json

@@ -25,7 +25,7 @@
   "engines": {
     "node": ">=18.0.0"
   },
-  "packageManager": "pnpm@10.22.0",
+  "packageManager": "pnpm@10.23.0",
   "publishConfig": {
     "access": "public"
   },

src/client/base.ts

@@ -58,7 +58,7 @@ export class BaseIterableClient {
       };
 
       this.client = axios.create({
-        baseURL: clientConfig.baseUrl || "https://api.iterable.com",
+        baseURL: clientConfig.baseUrl,
         headers: {
           ...defaultHeaders,
           ...(clientConfig.customHeaders || {}),

src/client/index.ts

@@ -1,3 +1,6 @@
+import type { AxiosInstance } from "axios";
+
+import type { IterableConfig } from "../types/common.js";
 import { BaseIterableClient } from "./base.js";
 import { Campaigns } from "./campaigns.js";
 import { Catalogs } from "./catalogs.js";
@@ -62,4 +65,14 @@ export class IterableClient extends compose(
   Templates,
   Users,
   Webhooks
-) {}
+) {
+  /**
+   * Create a new Iterable API client
+   *
+   * @param config - Optional configuration object. If not provided, will use environment variables
+   * @param injectedClient - Optional pre-configured Axios instance for testing
+   */
+  constructor(config?: IterableConfig, injectedClient?: AxiosInstance) {
+    super(config, injectedClient);
+  }
+}

src/types/common.ts

@@ -107,7 +107,7 @@ export type IterableErrorResponse = z.infer<typeof IterableErrorResponseSchema>;
 
 export const IterableConfigSchema = z.object({
   apiKey: z.string(),
-  baseUrl: z.string().optional(),
+  baseUrl: z.url(),
   timeout: z.number().optional(),
   debug: z.boolean().optional(),
   debugVerbose: z.boolean().optional(),

tests/unit/client.test.ts

@@ -0,0 +1,90 @@
+/**
+ * Tests for IterableClient constructor - verifies that baseUrl is required
+ * and properly used at runtime
+ */
+
+import { IterableClient } from "../../src/client/index.js";
+
+describe("IterableClient", () => {
+  describe("Constructor with baseUrl", () => {
+    it("should use US endpoint when explicitly provided", () => {
+      const client = new IterableClient({
+        apiKey: "a1b2c3d4e5f6789012345678901234ab",
+        baseUrl: "https://api.iterable.com",
+      });
+
+      expect(client).toBeDefined();
+      expect(client.client.defaults.baseURL).toBe("https://api.iterable.com");
+    });
+
+    it("should use EU endpoint when explicitly provided", () => {
+      const client = new IterableClient({
+        apiKey: "a1b2c3d4e5f6789012345678901234ab",
+        baseUrl: "https://api.eu.iterable.com",
+      });
+
+      expect(client).toBeDefined();
+      expect(client.client.defaults.baseURL).toBe(
+        "https://api.eu.iterable.com"
+      );
+    });
+
+    it("should use custom endpoint when provided", () => {
+      const client = new IterableClient({
+        apiKey: "a1b2c3d4e5f6789012345678901234ab",
+        baseUrl: "https://custom.api.example.com",
+      });
+
+      expect(client).toBeDefined();
+      expect(client.client.defaults.baseURL).toBe(
+        "https://custom.api.example.com"
+      );
+    });
+
+    it("should accept all valid IterableConfig properties", () => {
+      const client = new IterableClient({
+        apiKey: "a1b2c3d4e5f6789012345678901234ab",
+        baseUrl: "https://api.iterable.com",
+        timeout: 45000,
+        debug: false,
+        debugVerbose: true,
+        customHeaders: {
+          "X-Custom-1": "value1",
+          "X-Custom-2": "value2",
+        },
+      });
+
+      expect(client).toBeDefined();
+      expect(client.client.defaults.baseURL).toBe("https://api.iterable.com");
+      expect(client.client.defaults.timeout).toBe(45000);
+    });
+  });
+
+  describe("Constructor with Injected Client", () => {
+    it("should use the injected axios instance ignoring baseUrl config", () => {
+      const mockAxios = {
+        defaults: {
+          // note this is the axios instance's baseURL, not the IterableConfig's baseUrl
+          baseURL: "https://mock.example.com",
+        },
+        interceptors: {
+          request: { use: jest.fn() },
+          response: { use: jest.fn() },
+        },
+      } as any;
+
+      const client = new IterableClient(
+        {
+          apiKey: "a1b2c3d4e5f6789012345678901234ab",
+          baseUrl: "https://api.iterable.com",
+        },
+        mockAxios
+      );
+
+      expect(client).toBeDefined();
+      expect(client.client).toBe(mockAxios);
+      // The injected client's baseURL should be preserved, not overridden
+      expect(client.client.defaults.baseURL).toBe("https://mock.example.com");
+    });
+  });
+});