newscatcher-catchall-sdk 1.0.0 → 1.3.1

package/dist/{cjs/api/types/JobStatus.d.ts → esm/api/types/PublicJobStatus.d.mts}

@@ -3,15 +3,15 @@
  *
  * - `submitted`: Job queued, waiting to start processing.
  * - `analyzing`: Extracting keywords, generating search queries, and creating validators/extractors.
- * - `fetching`: Retrieving articles from web sources.
- * - `clustering`: Grouping similar articles into distinct events.
+ * - `fetching`: Retrieving web pages.
+ * - `clustering`: Grouping similar web pages into clusters.
  * - `enriching`: Validating clusters and extracting structured data.
  * - `completed`: Job finished successfully, results ready.
  * - `failed`: Job processing failed.
  *
  * Poll `/catchAll/status/{job_id}` every 30-60 seconds until status is `completed` (typically 10-15 minutes).
  */
-export declare const JobStatus: {
+export declare const PublicJobStatus: {
     readonly Submitted: "submitted";
     readonly Analyzing: "analyzing";
     readonly Fetching: "fetching";
@@ -20,4 +20,4 @@ export declare const JobStatus: {
     readonly Completed: "completed";
     readonly Failed: "failed";
 };
-export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
+export type PublicJobStatus = (typeof PublicJobStatus)[keyof typeof PublicJobStatus];

package/dist/esm/api/types/{JobStatus.mjs → PublicJobStatus.mjs}

@@ -4,15 +4,15 @@
  *
  * - `submitted`: Job queued, waiting to start processing.
  * - `analyzing`: Extracting keywords, generating search queries, and creating validators/extractors.
- * - `fetching`: Retrieving articles from web sources.
- * - `clustering`: Grouping similar articles into distinct events.
+ * - `fetching`: Retrieving web pages.
+ * - `clustering`: Grouping similar web pages into clusters.
  * - `enriching`: Validating clusters and extracting structured data.
  * - `completed`: Job finished successfully, results ready.
  * - `failed`: Job processing failed.
  *
  * Poll `/catchAll/status/{job_id}` every 30-60 seconds until status is `completed` (typically 10-15 minutes).
  */
-export const JobStatus = {
+export const PublicJobStatus = {
     Submitted: "submitted",
     Analyzing: "analyzing",
     Fetching: "fetching",

package/dist/esm/api/types/PullJobResponseDto.d.mts

@@ -2,44 +2,53 @@ import type * as CatchAllApi from "../index.mjs";
 export interface PullJobResponseDto {
     /** Job identifier. */
     job_id: string;
-    /** Original natural language query. */
-    query?: string;
+    /** Original plain text query. */
+    query?: string | undefined;
     /** Context provided with the query. */
-    context?: string;
-    /** List of validation criteria applied to filter results. */
-    validators?: string[];
-    /**
-     * List of extracted field names generated by the enrichment process.
-     * These field names appear in the `enrichment` object of each record.
-     */
-    enrichments?: string[];
+    context?: string | undefined;
+    /** Validators applied to filter results. */
+    validators?: Record<string, unknown>[] | undefined;
+    /** Enrichment fields used for data extraction. */
+    enrichments?: Record<string, unknown>[] | undefined;
     /** Job status. */
-    status: string;
+    status?: string | undefined;
+    /** Error message if the job failed. Null for successful jobs. */
+    error?: (string | null) | undefined;
+    /** Record limit for this job. Reflects the value specified at submit time, or the plan default if no limit was provided. */
+    limit?: number | undefined;
     /** Total time taken to process the job. */
-    duration?: string;
-    /** Number of distinct event clusters identified before validation. */
-    candidate_records?: number;
+    duration?: string | undefined;
+    /** Total number of distinct event clusters identified. Compare with `progress_validated` to estimate how many candidates remain unprocessed for job continuation. */
+    candidate_records?: number | undefined;
     /** Number of validated records extracted. */
-    valid_records?: number;
+    valid_records?: number | undefined;
     /**
      * Number of candidate clusters that have been validated during processing.
      *
-     * The system process data in batches. This field tracks how many candidates have been checked against validation criteria so far.
+     * The system process data in batches. This field tracks how many `candidate_records` have been checked against validation criteria so far.
      */
-    progress_validated?: number;
-    date_range?: PullJobResponseDto.DateRange;
+    progress_validated?: (number | null) | undefined;
+    date_range?: PullJobResponseDto.DateRange | undefined;
     /** The current page number. */
-    page?: number;
-    /** The total number of pages available. */
-    total_pages?: number;
+    page?: number | undefined;
     /** The number of records per page. */
-    page_size?: number;
+    page_size?: number | undefined;
+    /** The total number of pages available. */
+    total_pages?: number | undefined;
+    /** Processing mode used for this job. */
+    mode?: PullJobResponseDto.Mode | undefined;
     /** Array of extracted records with structured data and citations. */
-    all_records?: CatchAllApi.Record_[];
+    all_records?: CatchAllApi.Record_[] | undefined;
 }
 export declare namespace PullJobResponseDto {
     interface DateRange {
-        start_date?: string;
-        end_date?: string;
+        start_date?: string | undefined;
+        end_date?: string | undefined;
     }
+    /** Processing mode used for this job. */
+    const Mode: {
+        readonly Lite: "lite";
+        readonly Base: "base";
+    };
+    type Mode = (typeof Mode)[keyof typeof Mode];
 }

package/dist/esm/api/types/PullJobResponseDto.mjs

@@ -1,2 +1,9 @@
 // This file was auto-generated by Fern from our API Definition.
-export {};
+export var PullJobResponseDto;
+(function (PullJobResponseDto) {
+    /** Processing mode used for this job. */
+    PullJobResponseDto.Mode = {
+        Lite: "lite",
+        Base: "base",
+    };
+})(PullJobResponseDto || (PullJobResponseDto = {}));

package/dist/esm/api/types/PullMonitorResponseDto.d.mts

@@ -3,24 +3,24 @@ export interface PullMonitorResponseDto {
     /** Unique identifier for the monitor. */
     monitor_id: string;
     /**
-     * Parsed cron expression from the natural language schedule.
+     * The cron expression for a monitor schedule parsed from the text schedule you provide.
+     *
      * Standard cron format (minute hour day month day-of-week).
      */
-    cron_expression?: string;
+    cron_expression?: string | undefined;
     /** Timezone used for schedule execution. */
-    timezone?: string;
+    timezone?: string | undefined;
     reference_job: CatchAllApi.ReferenceJob;
     /** Execution time range for this monitor. */
-    run_info?: PullMonitorResponseDto.RunInfo;
+    run_info?: PullMonitorResponseDto.RunInfo | undefined;
     /** Total number of records collected across all monitor jobs. */
-    records?: number;
+    records?: number | undefined;
     /** Current monitor status or error message if monitor creation failed. */
     status: string;
-    /**
-     * Aggregated records from all jobs executed by this monitor.
-     * Each record includes structured data extracted from web sources with citations.
-     */
-    all_records?: CatchAllApi.MonitorRecord[];
+    /** Aggregated records from all jobs executed by this monitor. Each record includes structured data extracted from web sources with citations. */
+    all_records?: CatchAllApi.MonitorRecord[] | undefined;
+    /** Record limit applied to this monitor's jobs. */
+    limit?: (number | null) | undefined;
 }
 export declare namespace PullMonitorResponseDto {
     /**
@@ -28,8 +28,8 @@ export declare namespace PullMonitorResponseDto {
      */
     interface RunInfo {
         /** Timestamp of the first job execution. */
-        first_run?: string;
+        first_run?: string | undefined;
         /** Timestamp of the most recent job execution. */
-        last_run?: string;
+        last_run?: string | undefined;
     }
 }

package/dist/esm/api/types/Query.d.mts

@@ -1,5 +1,5 @@
 /**
- * Natural language question describing what to find.
+ * Plain text question describing what to find.
  *
  * The system analyzes your input to generate search queries, validators, and extractors. More specific queries produce more focused results.
  */

package/dist/esm/api/types/Record_.d.mts

@@ -1,15 +1,5 @@
 import type * as CatchAllApi from "../index.mjs";
-export interface Record_ {
-    /** Unique identifier for the record. */
-    record_id: string;
-    /** Short title summarizing the record. */
-    record_title: string;
-    /**
-     * Structured data extracted from articles. Schema is dynamically generated per job. Field names are chosen semantically to match the content.
-     *
-     * See [Understanding dynamic schemas](https://www.newscatcherapi.com/docs/v3/catch-all/overview/dynamic-schemas) for integration guidance.
-     */
-    enrichment: Record<string, unknown>;
-    /** Source articles that were used to extract this record. */
+export interface Record_ extends CatchAllApi.BaseRecord {
+    /** Source documents that were used to extract this record. */
     citations: CatchAllApi.Citation[];
 }

package/dist/esm/api/types/ReferenceJob.d.mts

@@ -1,6 +1,6 @@
 export interface ReferenceJob {
-    /** Natural language query from the reference job. */
-    query?: string;
+    /** Plain text query from the reference job. */
+    query?: string | undefined;
     /** Context provided with the reference job query. */
-    context?: string;
+    context?: string | undefined;
 }

package/dist/esm/api/types/StartDate.d.mts

@@ -1,6 +1,8 @@
 /**
- * Start of date range for article search (ISO 8601 format with UTC timezone).
+ * Start date for web search (ISO 8601 format with UTC timezone).
  *
- * Must be within plan's allowed lookback period. Default is 5 days before current date if not specified.
+ * Defines the start of the search window by web page discovery date, not event date. Web pages discovered within this range may describe events from any time period.
+ *
+ * Must be within plan's allowed search depth. Default is 5 days before current date if not specified.
  */
 export type StartDate = string;

package/dist/esm/api/types/StatusResponseDto.d.mts

@@ -3,7 +3,7 @@ export interface StatusResponseDto {
     /** Job identifier. */
     job_id: string;
     /** Current job processing status. */
-    status?: CatchAllApi.JobStatus;
+    status?: CatchAllApi.PublicJobStatus | undefined;
     /** Detailed progress tracking for each processing stage. Steps progress sequentially from order 1 (submitted) through 5 (enriching), ending at order 6 (completed) or 7 (failed). */
-    steps: CatchAllApi.JobStep[];
+    steps?: CatchAllApi.JobStep[] | undefined;
 }

package/dist/esm/api/types/{SubmitResponseBody.d.mts → SubmitResponseDto.d.mts}

@@ -1,4 +1,4 @@
-export interface SubmitResponseBody {
+export interface SubmitResponseDto {
     /** Unique identifier for the created job. Use this to check status and retrieve results. */
     job_id: string;
 }

package/dist/esm/api/types/SubmitResponseDto.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/UserJob.d.mts

@@ -1,10 +1,22 @@
 export interface UserJob {
     /** Job identifier. */
     job_id: string;
-    /** Natural language query for this job. */
+    /** Plain text query for this job. */
     query: string;
     /** Job creation timestamp in ISO 8601 format. */
     created_at: string;
     /** Current processing status of the job. */
     status: string;
+    /** Processing mode used for this job. */
+    mode?: UserJob.Mode | undefined;
+    /** Masked API key that created this job. */
+    user_key?: string | undefined;
+}
+export declare namespace UserJob {
+    /** Processing mode used for this job. */
+    const Mode: {
+        readonly Lite: "lite";
+        readonly Base: "base";
+    };
+    type Mode = (typeof Mode)[keyof typeof Mode];
 }

package/dist/esm/api/types/UserJob.mjs

@@ -1,2 +1,9 @@
 // This file was auto-generated by Fern from our API Definition.
-export {};
+export var UserJob;
+(function (UserJob) {
+    /** Processing mode used for this job. */
+    UserJob.Mode = {
+        Lite: "lite",
+        Base: "base",
+    };
+})(UserJob || (UserJob = {}));

package/dist/esm/api/types/ValidationErrorDetail.d.mts

@@ -1,10 +1,10 @@
 export interface ValidationErrorDetail {
     /** Location of the validation error */
-    loc?: ValidationErrorDetail.Loc.Item[];
+    loc?: ValidationErrorDetail.Loc.Item[] | undefined;
     /** Error message */
-    msg?: string;
+    msg?: string | undefined;
     /** Error type */
-    type?: string;
+    type?: string | undefined;
 }
 export declare namespace ValidationErrorDetail {
     type Loc = Loc.Item[];

package/dist/esm/api/types/ValidationErrorResponse.d.mts

@@ -1,4 +1,4 @@
 import type * as CatchAllApi from "../index.mjs";
 export interface ValidationErrorResponse {
-    detail?: CatchAllApi.ValidationErrorDetail[];
+    detail?: CatchAllApi.ValidationErrorDetail[] | undefined;
 }

package/dist/esm/api/types/ValidatorSchema.d.mts

@@ -1,13 +1,13 @@
 /**
- * Schema for a single validator that filters article clusters.
+ * Schema for a single validator that filters clusters of web pages.
  *
  * Validators are applied during the enriching stage to determine which clusters are relevant.
  */
 export interface ValidatorSchema {
     /** Validator field name (snake_case recommended). */
     name: string;
-    /** What this validator checks for in the article. */
+    /** What this validator checks for in the web page. */
     description: string;
     /** Validator type (currently only boolean supported). */
-    type?: "boolean";
+    type?: "boolean" | undefined;
 }

package/dist/esm/api/types/WebhookDto.d.mts

@@ -2,13 +2,13 @@ export interface WebhookDto {
     /** Webhook endpoint URL. */
     url: string;
     /** HTTP method to use. */
-    method?: WebhookDto.Method;
+    method?: WebhookDto.Method | undefined;
     /** HTTP headers to include in request. */
-    headers?: Record<string, string>;
+    headers?: Record<string, string> | undefined;
     /** Query string parameters. */
-    params?: Record<string, unknown>;
+    params?: Record<string, unknown> | undefined;
     /** Basic auth credentials [username, password]. */
-    auth?: string[];
+    auth?: string[] | undefined;
 }
 export declare namespace WebhookDto {
     /** HTTP method to use. */

package/dist/esm/api/types/WebhookPayload.d.mts

@@ -6,21 +6,21 @@ import type * as CatchAllApi from "../index.mjs";
  */
 export interface WebhookPayload {
     /** Monitor identifier. */
-    monitor_id?: string;
+    monitor_id?: string | undefined;
     /** Reference job used as template for this monitor. */
-    reference_job_id?: string;
+    reference_job_id?: string | undefined;
     /** Job ID of the most recent execution. */
-    latest_job_id?: string;
+    latest_job_id?: string | undefined;
     /** Number of new records from latest job (after deduplication). */
-    records_count?: number;
+    records_count?: number | undefined;
     /** Total number of jobs executed by this monitor. */
-    jobs_processed?: number;
+    jobs_processed?: number | undefined;
     /** The date when the webhook was triggered in ISO 8601 format with UTC timezone. */
-    updated_at?: string;
+    updated_at?: string | undefined;
     /** Cron expression defining the monitor schedule. */
-    cron_expression?: string;
+    cron_expression?: string | undefined;
     /** Timezone for schedule execution. */
-    timezone?: string;
+    timezone?: string | undefined;
     /** Array of new records from the latest job execution (includes monitor-specific fields like added_on, updated_on). */
-    records?: CatchAllApi.MonitorRecord[];
+    records?: CatchAllApi.MonitorRecord[] | undefined;
 }

package/dist/esm/api/types/index.d.mts

@@ -1,4 +1,6 @@
+export * from "./BaseRecord.mjs";
 export * from "./Citation.mjs";
+export * from "./CompanyEnrichmentOutput.mjs";
 export * from "./Context.mjs";
 export * from "./ContinueResponseDto.mjs";
 export * from "./CreateMonitorResponseDto.mjs";
@@ -6,8 +8,8 @@ export * from "./EndDate.mjs";
 export * from "./EnrichmentSchema.mjs";
 export * from "./EnrichmentType.mjs";
 export * from "./Error_.mjs";
+export * from "./GetPlanLimitsResponseDto.mjs";
 export * from "./InitializeResponseDto.mjs";
-export * from "./JobStatus.mjs";
 export * from "./JobStep.mjs";
 export * from "./Limit.mjs";
 export * from "./ListMonitorsResponseDto.mjs";
@@ -16,15 +18,16 @@ export * from "./MonitorCitation.mjs";
 export * from "./MonitorJobItem.mjs";
 export * from "./MonitorListItemDto.mjs";
 export * from "./MonitorRecord.mjs";
+export * from "./PlanFeature.mjs";
+export * from "./PublicJobStatus.mjs";
 export * from "./PullJobResponseDto.mjs";
 export * from "./PullMonitorResponseDto.mjs";
 export * from "./Query.mjs";
 export * from "./Record_.mjs";
 export * from "./ReferenceJob.mjs";
-export * from "./Schema.mjs";
 export * from "./StartDate.mjs";
 export * from "./StatusResponseDto.mjs";
-export * from "./SubmitResponseBody.mjs";
+export * from "./SubmitResponseDto.mjs";
 export * from "./UpdateMonitorResponseDto.mjs";
 export * from "./UserJob.mjs";
 export * from "./ValidationErrorDetail.mjs";

package/dist/esm/api/types/index.mjs

@@ -1,4 +1,6 @@
+export * from "./BaseRecord.mjs";
 export * from "./Citation.mjs";
+export * from "./CompanyEnrichmentOutput.mjs";
 export * from "./Context.mjs";
 export * from "./ContinueResponseDto.mjs";
 export * from "./CreateMonitorResponseDto.mjs";
@@ -6,8 +8,8 @@ export * from "./EndDate.mjs";
 export * from "./EnrichmentSchema.mjs";
 export * from "./EnrichmentType.mjs";
 export * from "./Error_.mjs";
+export * from "./GetPlanLimitsResponseDto.mjs";
 export * from "./InitializeResponseDto.mjs";
-export * from "./JobStatus.mjs";
 export * from "./JobStep.mjs";
 export * from "./Limit.mjs";
 export * from "./ListMonitorsResponseDto.mjs";
@@ -16,15 +18,16 @@ export * from "./MonitorCitation.mjs";
 export * from "./MonitorJobItem.mjs";
 export * from "./MonitorListItemDto.mjs";
 export * from "./MonitorRecord.mjs";
+export * from "./PlanFeature.mjs";
+export * from "./PublicJobStatus.mjs";
 export * from "./PullJobResponseDto.mjs";
 export * from "./PullMonitorResponseDto.mjs";
 export * from "./Query.mjs";
 export * from "./Record_.mjs";
 export * from "./ReferenceJob.mjs";
-export * from "./Schema.mjs";
 export * from "./StartDate.mjs";
 export * from "./StatusResponseDto.mjs";
-export * from "./SubmitResponseBody.mjs";
+export * from "./SubmitResponseDto.mjs";
 export * from "./UpdateMonitorResponseDto.mjs";
 export * from "./UserJob.mjs";
 export * from "./ValidationErrorDetail.mjs";

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

@@ -14,6 +14,6 @@ export type BinaryResponse = {
      * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bytes)
      * Some versions of the Fetch API may not support this method.
      */
-    bytes?(): ReturnType<Response["bytes"]>;
+    bytes?(): Promise<Uint8Array>;
 };
 export declare function getBinaryResponse(response: Response): BinaryResponse;

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

@@ -152,7 +152,13 @@ function getHeaders(args) {
     return __awaiter(this, void 0, void 0, function* () {
         var _a;
         const newHeaders = new Headers();
-        newHeaders.set("Accept", args.responseType === "json" ? "application/json" : args.responseType === "text" ? "text/plain" : "*/*");
+        newHeaders.set("Accept", args.responseType === "json"
+            ? "application/json"
+            : args.responseType === "text"
+                ? "text/plain"
+                : args.responseType === "sse"
+                    ? "text/event-stream"
+                    : "*/*");
         if (args.body !== undefined && args.contentType != null) {
             newHeaders.set("Content-Type", args.contentType);
         }
@@ -196,7 +202,7 @@ export function fetcherImpl(args) {
         }
         try {
             const response = yield requestWithRetries(() => __awaiter(this, void 0, void 0, function* () {
-                return makeRequest(fetchFn, url, args.method, headers, requestBody, args.timeoutMs, args.abortSignal, args.withCredentials, args.duplex);
+                return makeRequest(fetchFn, url, args.method, headers, requestBody, args.timeoutMs, args.abortSignal, args.withCredentials, args.duplex, args.responseType === "streaming" || args.responseType === "sse");
             }), args.maxRetries);
             if (response.status >= 200 && response.status < 400) {
                 if (logger.isDebug()) {

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

@@ -6,6 +6,8 @@ export type { Fetcher, FetchFunction } from "./Fetcher.mjs";
 export { fetcher } from "./Fetcher.mjs";
 export { getHeader } from "./getHeader.mjs";
 export { HttpResponsePromise } from "./HttpResponsePromise.mjs";
+export type { PassthroughRequest } from "./makePassthroughRequest.mjs";
+export { makePassthroughRequest } from "./makePassthroughRequest.mjs";
 export type { RawResponse, WithRawResponse } from "./RawResponse.mjs";
 export { abortRawResponse, toRawResponse, unknownRawResponse } from "./RawResponse.mjs";
 export { Supplier } from "./Supplier.mjs";

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

@@ -2,5 +2,6 @@ export { EndpointSupplier } from "./EndpointSupplier.mjs";
 export { fetcher } from "./Fetcher.mjs";
 export { getHeader } from "./getHeader.mjs";
 export { HttpResponsePromise } from "./HttpResponsePromise.mjs";
+export { makePassthroughRequest } from "./makePassthroughRequest.mjs";
 export { abortRawResponse, toRawResponse, unknownRawResponse } from "./RawResponse.mjs";
 export { Supplier } from "./Supplier.mjs";

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>;