newscatcher-catchall-sdk 1.1.2 → 1.3.1

package/dist/esm/core/fetcher/makePassthroughRequest.d.mts

@@ -0,0 +1,49 @@
+import { type LogConfig, type Logger } from "../logging/logger.mjs";
+import { Supplier } from "./Supplier.mjs";
+export declare namespace PassthroughRequest {
+    /**
+     * Per-request options that can override the SDK client defaults.
+     */
+    interface RequestOptions {
+        /** Override the default timeout for this request (in seconds). */
+        timeoutInSeconds?: number;
+        /** Override the default number of retries for this request. */
+        maxRetries?: number;
+        /** Additional headers to include in this request. */
+        headers?: Record<string, string>;
+        /** Abort signal for this request. */
+        abortSignal?: AbortSignal;
+    }
+    /**
+     * SDK client configuration used by the passthrough fetch method.
+     */
+    interface ClientOptions {
+        /** The base URL or environment for the client. */
+        environment?: Supplier<string>;
+        /** Override the base URL. */
+        baseUrl?: Supplier<string>;
+        /** Default headers to include in requests. */
+        headers?: Record<string, unknown>;
+        /** Default maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** Default number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A custom fetch function. */
+        fetch?: typeof fetch;
+        /** Logging configuration. */
+        logging?: LogConfig | Logger;
+        /** A function that returns auth headers. */
+        getAuthHeaders?: () => Promise<Record<string, string>>;
+    }
+}
+/**
+ * Makes a passthrough HTTP request using the SDK's configuration (auth, retry, logging, etc.)
+ * while mimicking the standard `fetch` API.
+ *
+ * @param input - The URL, path, or Request object. If a relative path, it will be resolved against the configured base URL.
+ * @param init - Standard RequestInit options (method, headers, body, signal, etc.)
+ * @param clientOptions - SDK client options (auth, default headers, logging, etc.)
+ * @param requestOptions - Per-request overrides (timeout, retries, extra headers, abort signal).
+ * @returns A standard Response object.
+ */
+export declare function makePassthroughRequest(input: Request | string | URL, init: RequestInit | undefined, clientOptions: PassthroughRequest.ClientOptions, requestOptions?: PassthroughRequest.RequestOptions): Promise<Response>;

package/dist/esm/core/fetcher/makePassthroughRequest.mjs

@@ -0,0 +1,132 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { createLogger } from "../logging/logger.mjs";
+import { join } from "../url/join.mjs";
+import { EndpointSupplier } from "./EndpointSupplier.mjs";
+import { getFetchFn } from "./getFetchFn.mjs";
+import { makeRequest } from "./makeRequest.mjs";
+import { requestWithRetries } from "./requestWithRetries.mjs";
+import { Supplier } from "./Supplier.mjs";
+/**
+ * Makes a passthrough HTTP request using the SDK's configuration (auth, retry, logging, etc.)
+ * while mimicking the standard `fetch` API.
+ *
+ * @param input - The URL, path, or Request object. If a relative path, it will be resolved against the configured base URL.
+ * @param init - Standard RequestInit options (method, headers, body, signal, etc.)
+ * @param clientOptions - SDK client options (auth, default headers, logging, etc.)
+ * @param requestOptions - Per-request overrides (timeout, retries, extra headers, abort signal).
+ * @returns A standard Response object.
+ */
+export function makePassthroughRequest(input, init, clientOptions, requestOptions) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, _b, _c, _d, _e, _f, _g;
+        const logger = createLogger(clientOptions.logging);
+        // Extract URL and default init properties from Request object if provided
+        let url;
+        let effectiveInit = init;
+        if (input instanceof Request) {
+            url = input.url;
+            // If no explicit init provided, extract properties from the Request object
+            if (init == null) {
+                effectiveInit = {
+                    method: input.method,
+                    headers: Object.fromEntries(input.headers.entries()),
+                    body: input.body,
+                    signal: input.signal,
+                    credentials: input.credentials,
+                    cache: input.cache,
+                    redirect: input.redirect,
+                    referrer: input.referrer,
+                    integrity: input.integrity,
+                    mode: input.mode,
+                };
+            }
+        }
+        else {
+            url = input instanceof URL ? input.toString() : input;
+        }
+        // Resolve the base URL
+        const baseUrl = (_a = (clientOptions.baseUrl != null ? yield Supplier.get(clientOptions.baseUrl) : undefined)) !== null && _a !== void 0 ? _a : (clientOptions.environment != null ? yield Supplier.get(clientOptions.environment) : undefined);
+        // Determine the full URL
+        let fullUrl;
+        if (url.startsWith("http://") || url.startsWith("https://")) {
+            fullUrl = url;
+        }
+        else if (baseUrl != null) {
+            fullUrl = join(baseUrl, url);
+        }
+        else {
+            fullUrl = url;
+        }
+        // Merge headers: SDK default headers -> auth headers -> user-provided headers
+        const mergedHeaders = {};
+        // Apply SDK default headers (resolve suppliers)
+        if (clientOptions.headers != null) {
+            for (const [key, value] of Object.entries(clientOptions.headers)) {
+                const resolved = yield EndpointSupplier.get(value, { endpointMetadata: {} });
+                if (resolved != null) {
+                    mergedHeaders[key.toLowerCase()] = `${resolved}`;
+                }
+            }
+        }
+        // Apply auth headers
+        if (clientOptions.getAuthHeaders != null) {
+            const authHeaders = yield clientOptions.getAuthHeaders();
+            for (const [key, value] of Object.entries(authHeaders)) {
+                mergedHeaders[key.toLowerCase()] = value;
+            }
+        }
+        // Apply user-provided headers from init
+        if ((effectiveInit === null || effectiveInit === void 0 ? void 0 : effectiveInit.headers) != null) {
+            const initHeaders = effectiveInit.headers instanceof Headers
+                ? Object.fromEntries(effectiveInit.headers.entries())
+                : Array.isArray(effectiveInit.headers)
+                    ? Object.fromEntries(effectiveInit.headers)
+                    : effectiveInit.headers;
+            for (const [key, value] of Object.entries(initHeaders)) {
+                if (value != null) {
+                    mergedHeaders[key.toLowerCase()] = value;
+                }
+            }
+        }
+        // Apply per-request option headers (highest priority)
+        if ((requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers) != null) {
+            for (const [key, value] of Object.entries(requestOptions.headers)) {
+                mergedHeaders[key.toLowerCase()] = value;
+            }
+        }
+        const method = (_b = effectiveInit === null || effectiveInit === void 0 ? void 0 : effectiveInit.method) !== null && _b !== void 0 ? _b : "GET";
+        const body = effectiveInit === null || effectiveInit === void 0 ? void 0 : effectiveInit.body;
+        const timeoutInSeconds = (_c = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _c !== void 0 ? _c : clientOptions.timeoutInSeconds;
+        const timeoutMs = timeoutInSeconds != null ? timeoutInSeconds * 1000 : undefined;
+        const maxRetries = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _d !== void 0 ? _d : clientOptions.maxRetries;
+        const abortSignal = (_f = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal) !== null && _e !== void 0 ? _e : effectiveInit === null || effectiveInit === void 0 ? void 0 : effectiveInit.signal) !== null && _f !== void 0 ? _f : undefined;
+        const fetchFn = (_g = clientOptions.fetch) !== null && _g !== void 0 ? _g : (yield getFetchFn());
+        if (logger.isDebug()) {
+            logger.debug("Making passthrough HTTP request", {
+                method,
+                url: fullUrl,
+                hasBody: body != null,
+            });
+        }
+        const response = yield requestWithRetries(() => __awaiter(this, void 0, void 0, function* () {
+            return makeRequest(fetchFn, fullUrl, method, mergedHeaders, body !== null && body !== void 0 ? body : undefined, timeoutMs, abortSignal, (effectiveInit === null || effectiveInit === void 0 ? void 0 : effectiveInit.credentials) === "include", undefined, // duplex
+            false);
+        }), maxRetries);
+        if (logger.isDebug()) {
+            logger.debug("Passthrough HTTP request completed", {
+                method,
+                url: fullUrl,
+                statusCode: response.status,
+            });
+        }
+        return response;
+    });
+}

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.1.2";
+export declare const SDK_VERSION = "1.3.1";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "1.1.2";
+export const SDK_VERSION = "1.3.1";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "newscatcher-catchall-sdk",
-    "version": "1.1.2",
+    "version": "1.3.1",
     "private": false,
     "repository": {
         "type": "git",

package/reference.md

@@ -98,7 +98,8 @@ await client.jobs.createJob({
     context: "Focus on funding amount and company name",
     limit: 10,
     start_date: "2026-02-18T00:00:00Z",
-    end_date: "2026-02-23T00:00:00Z"
+    end_date: "2026-02-23T00:00:00Z",
+    mode: "base"
 });
 
 ```
@@ -977,3 +978,58 @@ await client.meta.getVersion();
 </dl>
 </details>
 
+<details><summary><code>client.meta.<a href="/src/api/resources/meta/client/Client.ts">getPlanLimits</a>() -> CatchAllApi.GetPlanLimitsResponseDto</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns plan features and current usage for the authenticated organization.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.meta.getPlanLimits();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `MetaClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+