release: 0.3.0

.github/workflows/detect-breaking-changes.yml

@@ -0,0 +1,36 @@
+name: CI
+on:
+  pull_request:
+    branches:
+      - main
+      - next
+
+jobs:
+  detect_breaking_changes:
+    runs-on: 'ubuntu-latest'
+    name: detect-breaking-changes
+    if: github.repository == 'parallel-web/parallel-sdk-typescript'
+    steps:
+      - name: Calculate fetch-depth
+        run: |
+          echo "FETCH_DEPTH=$(expr ${{ github.event.pull_request.commits }} + 1)" >> $GITHUB_ENV
+
+      - uses: actions/checkout@v4
+        with:
+          # Ensure we can check out the pull request base in the script below.
+          fetch-depth: ${{ env.FETCH_DEPTH }}
+
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+      - name: Install dependencies
+        run: |
+          yarn install
+
+      - name: Detect breaking changes
+        run: |
+          # Try to check out previous versions of the breaking change detection script. This ensures that
+          # we still detect breaking changes when entire files and their tests are removed.
+          git checkout "${{ github.event.pull_request.base.sha }}" -- ./scripts/detect-breaking-changes 2>/dev/null || true
+          ./scripts/detect-breaking-changes ${{ github.event.pull_request.base.sha }}

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.2.4"
+  ".": "0.3.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 22
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/parallel-web%2Fparallel-sdk-70ca78f3dbacd1f8145c633b64c2d9eec9f390db6110ce98705427248a22f19f.yml
-openapi_spec_hash: 877617cbe6e7a48410632dbb57ff5488
-config_hash: 6a16116c579cf9a3739083c24b10534d
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/parallel-web%2Fparallel-sdk-105d778ad64daf94bc1a8b074c609be5200c570c8a3e9fb646d418d572083dac.yml
+openapi_spec_hash: b5d7390ed05ec6f332a1a91266a74ac3
+config_hash: a398d153133d8884bed4e5256a0ae818

CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## 0.3.0 (2026-01-13)
+
+Full Changelog: [v0.2.4...v0.3.0](https://github.com/parallel-web/parallel-sdk-typescript/compare/v0.2.4...v0.3.0)
+
+### Features
+
+* **api:** add after_date, update findAll nomenclature ([d32f54b](https://github.com/parallel-web/parallel-sdk-typescript/commit/d32f54b4958d0f47135e3f6e612ebd92cd5a139f))
+* **api:** Update excerpt settings ([58c9f47](https://github.com/parallel-web/parallel-sdk-typescript/commit/58c9f47cd642a29a3daf5e6efcf75462639376ac))
+* **ci:** add breaking change detection workflow ([7cff646](https://github.com/parallel-web/parallel-sdk-typescript/commit/7cff646f03b344932da9b1f41a2194935c0ecca5))
+
+
+### Bug Fixes
+
+* **api:** add aliases for old findAll types ([d06ae98](https://github.com/parallel-web/parallel-sdk-typescript/commit/d06ae9826af167dd35cf54a98ce5d80b00dbb833))
+* **mcp:** correct code tool API endpoint ([e9a925c](https://github.com/parallel-web/parallel-sdk-typescript/commit/e9a925cc5da68a7da81a78826df3a6b71d87e7b5))
+* **mcp:** return correct lines on typescript errors ([d6854e6](https://github.com/parallel-web/parallel-sdk-typescript/commit/d6854e660599668a38c679df3c60f311b1569a4a))
+
+
+### Chores
+
+* **api:** update default headers ([e7bcf21](https://github.com/parallel-web/parallel-sdk-typescript/commit/e7bcf210dcfcef9e444218abdf7f0d8d4dfc7d13))
+* break long lines in snippets into multiline ([148860c](https://github.com/parallel-web/parallel-sdk-typescript/commit/148860cb2d1fe30406d81f7eee60c51203dfad68))
+* **client:** fix logger property type ([2d7f64b](https://github.com/parallel-web/parallel-sdk-typescript/commit/2d7f64b25314670de513eda5cb70d2c3b70300fd))
+* fix lint ([d8fff0a](https://github.com/parallel-web/parallel-sdk-typescript/commit/d8fff0aa2479182e4b51e58fc8757911d5c06c5a))
+* **internal:** codegen related update ([d941a00](https://github.com/parallel-web/parallel-sdk-typescript/commit/d941a00eb40c9c3cd056da2fd6955d2aade94849))
+* **internal:** codegen related update ([bc0b8b1](https://github.com/parallel-web/parallel-sdk-typescript/commit/bc0b8b1167be0a5426a1d151e6bcefb7d884fe0c))
+* **internal:** codegen related update ([5ae66ee](https://github.com/parallel-web/parallel-sdk-typescript/commit/5ae66ee9239566c97fe41dd591acf8f58a3252bb))
+* **internal:** upgrade eslint ([e6780b0](https://github.com/parallel-web/parallel-sdk-typescript/commit/e6780b01053f2ef5a09dd544b32223f1cfc2db9b))
+
 ## 0.2.4 (2025-11-13)
 
 Full Changelog: [v0.2.3...v0.2.4](https://github.com/parallel-web/parallel-sdk-typescript/compare/v0.2.3...v0.2.4)

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2025 Parallel
+Copyright 2026 Parallel
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

api.md

@@ -85,32 +85,31 @@ Methods:
 - <code title="get /v1beta/tasks/groups/{taskgroup_id}/events">client.beta.taskGroup.<a href="./src/resources/beta/task-group.ts">events</a>(taskGroupID, { ...params }) -> TaskGroupEventsResponse</code>
 - <code title="get /v1beta/tasks/groups/{taskgroup_id}/runs">client.beta.taskGroup.<a href="./src/resources/beta/task-group.ts">getRuns</a>(taskGroupID, { ...params }) -> TaskGroupGetRunsResponse</code>
 
-## Findall
+## FindAll
 
 Types:
 
-- <code><a href="./src/resources/beta/findall.ts">FindallCandidateMatchStatusEvent</a></code>
-- <code><a href="./src/resources/beta/findall.ts">FindallEnrichInput</a></code>
-- <code><a href="./src/resources/beta/findall.ts">FindallExtendInput</a></code>
-- <code><a href="./src/resources/beta/findall.ts">FindallRun</a></code>
-- <code><a href="./src/resources/beta/findall.ts">FindallRunInput</a></code>
-- <code><a href="./src/resources/beta/findall.ts">FindallRunResult</a></code>
-- <code><a href="./src/resources/beta/findall.ts">FindallRunStatusEvent</a></code>
-- <code><a href="./src/resources/beta/findall.ts">FindallSchema</a></code>
-- <code><a href="./src/resources/beta/findall.ts">FindallSchemaUpdatedEvent</a></code>
+- <code><a href="./src/resources/beta/findall.ts">FindAllCandidateMatchStatusEvent</a></code>
+- <code><a href="./src/resources/beta/findall.ts">FindAllEnrichInput</a></code>
+- <code><a href="./src/resources/beta/findall.ts">FindAllExtendInput</a></code>
+- <code><a href="./src/resources/beta/findall.ts">FindAllRun</a></code>
+- <code><a href="./src/resources/beta/findall.ts">FindAllRunInput</a></code>
+- <code><a href="./src/resources/beta/findall.ts">FindAllRunResult</a></code>
+- <code><a href="./src/resources/beta/findall.ts">FindAllRunStatusEvent</a></code>
+- <code><a href="./src/resources/beta/findall.ts">FindAllSchema</a></code>
+- <code><a href="./src/resources/beta/findall.ts">FindAllSchemaUpdatedEvent</a></code>
 - <code><a href="./src/resources/beta/findall.ts">IngestInput</a></code>
-- <code><a href="./src/resources/beta/findall.ts">FindallRetrieveResponse</a></code>
-- <code><a href="./src/resources/beta/findall.ts">FindallCancelResponse</a></code>
-- <code><a href="./src/resources/beta/findall.ts">FindallEventsResponse</a></code>
+- <code><a href="./src/resources/beta/findall.ts">FindAllCancelResponse</a></code>
+- <code><a href="./src/resources/beta/findall.ts">FindAllEventsResponse</a></code>
 
 Methods:
 
-- <code title="post /v1beta/findall/runs">client.beta.findall.<a href="./src/resources/beta/findall.ts">create</a>({ ...params }) -> FindallRun</code>
-- <code title="get /v1beta/findall/runs/{findall_id}">client.beta.findall.<a href="./src/resources/beta/findall.ts">retrieve</a>(findallID, { ...params }) -> FindallRetrieveResponse</code>
+- <code title="post /v1beta/findall/runs">client.beta.findall.<a href="./src/resources/beta/findall.ts">create</a>({ ...params }) -> FindAllRun</code>
+- <code title="get /v1beta/findall/runs/{findall_id}">client.beta.findall.<a href="./src/resources/beta/findall.ts">retrieve</a>(findallID, { ...params }) -> FindAllRun</code>
 - <code title="post /v1beta/findall/runs/{findall_id}/cancel">client.beta.findall.<a href="./src/resources/beta/findall.ts">cancel</a>(findallID, { ...params }) -> unknown</code>
-- <code title="post /v1beta/findall/runs/{findall_id}/enrich">client.beta.findall.<a href="./src/resources/beta/findall.ts">enrich</a>(findallID, { ...params }) -> FindallSchema</code>
-- <code title="get /v1beta/findall/runs/{findall_id}/events">client.beta.findall.<a href="./src/resources/beta/findall.ts">events</a>(findallID, { ...params }) -> FindallEventsResponse</code>
-- <code title="post /v1beta/findall/runs/{findall_id}/extend">client.beta.findall.<a href="./src/resources/beta/findall.ts">extend</a>(findallID, { ...params }) -> FindallSchema</code>
-- <code title="post /v1beta/findall/ingest">client.beta.findall.<a href="./src/resources/beta/findall.ts">ingest</a>({ ...params }) -> FindallSchema</code>
-- <code title="get /v1beta/findall/runs/{findall_id}/result">client.beta.findall.<a href="./src/resources/beta/findall.ts">result</a>(findallID, { ...params }) -> FindallRunResult</code>
-- <code title="get /v1beta/findall/runs/{findall_id}/schema">client.beta.findall.<a href="./src/resources/beta/findall.ts">schema</a>(findallID, { ...params }) -> FindallSchema</code>
+- <code title="post /v1beta/findall/runs/{findall_id}/enrich">client.beta.findall.<a href="./src/resources/beta/findall.ts">enrich</a>(findallID, { ...params }) -> FindAllSchema</code>
+- <code title="get /v1beta/findall/runs/{findall_id}/events">client.beta.findall.<a href="./src/resources/beta/findall.ts">events</a>(findallID, { ...params }) -> FindAllEventsResponse</code>
+- <code title="post /v1beta/findall/runs/{findall_id}/extend">client.beta.findall.<a href="./src/resources/beta/findall.ts">extend</a>(findallID, { ...params }) -> FindAllSchema</code>
+- <code title="post /v1beta/findall/ingest">client.beta.findall.<a href="./src/resources/beta/findall.ts">ingest</a>({ ...params }) -> FindAllSchema</code>
+- <code title="get /v1beta/findall/runs/{findall_id}/result">client.beta.findall.<a href="./src/resources/beta/findall.ts">result</a>(findallID, { ...params }) -> FindAllRunResult</code>
+- <code title="get /v1beta/findall/runs/{findall_id}/schema">client.beta.findall.<a href="./src/resources/beta/findall.ts">schema</a>(findallID, { ...params }) -> FindAllSchema</code>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "parallel-web",
-  "version": "0.2.4",
+  "version": "0.3.0",
   "description": "The official TypeScript library for the Parallel API",
   "author": "Parallel <support@parallel.ai>",
   "types": "dist/index.d.ts",
@@ -35,7 +35,7 @@
     "@types/node": "^20.17.6",
     "@typescript-eslint/eslint-plugin": "8.31.1",
     "@typescript-eslint/parser": "8.31.1",
-    "eslint": "^9.20.1",
+    "eslint": "^9.39.1",
     "eslint-plugin-prettier": "^5.4.1",
     "eslint-plugin-unused-imports": "^4.1.4",
     "iconv-lite": "^0.6.3",

src/client.ts

@@ -129,7 +129,7 @@ export class Parallel {
   baseURL: string;
   maxRetries: number;
   timeout: number;
-  logger: Logger | undefined;
+  logger: Logger;
   logLevel: LogLevel | undefined;
   fetchOptions: MergedRequestInit | undefined;
 

src/resources/beta/beta.ts

@@ -2,30 +2,29 @@
 
 import { APIResource } from '../../core/resource';
 import * as Shared from '../shared';
-import * as FindallAPI from './findall';
+import * as FindAllAPI from './findall';
 import {
-  Findall,
-  FindallCancelParams,
-  FindallCancelResponse,
-  FindallCandidateMatchStatusEvent,
-  FindallCreateParams,
-  FindallEnrichInput,
-  FindallEnrichParams,
-  FindallEventsParams,
-  FindallEventsResponse,
-  FindallExtendInput,
-  FindallExtendParams,
-  FindallIngestParams,
-  FindallResultParams,
-  FindallRetrieveParams,
-  FindallRetrieveResponse,
-  FindallRun,
-  FindallRunInput,
-  FindallRunResult,
-  FindallRunStatusEvent,
-  FindallSchema,
-  FindallSchemaParams,
-  FindallSchemaUpdatedEvent,
+  FindAll,
+  FindAllCancelParams,
+  FindAllCancelResponse,
+  FindAllCandidateMatchStatusEvent,
+  FindAllCreateParams,
+  FindAllEnrichInput,
+  FindAllEnrichParams,
+  FindAllEventsParams,
+  FindAllEventsResponse,
+  FindAllExtendInput,
+  FindAllExtendParams,
+  FindAllIngestParams,
+  FindAllResultParams,
+  FindAllRetrieveParams,
+  FindAllRun,
+  FindAllRunInput,
+  FindAllRunResult,
+  FindAllRunStatusEvent,
+  FindAllSchema,
+  FindAllSchemaParams,
+  FindAllSchemaUpdatedEvent,
   IngestInput,
 } from './findall';
 import * as TaskGroupAPI from './task-group';
@@ -62,7 +61,7 @@ import { RequestOptions } from '../../internal/request-options';
 export class Beta extends APIResource {
   taskRun: TaskRunAPI.TaskRun = new TaskRunAPI.TaskRun(this._client);
   taskGroup: TaskGroupAPI.TaskGroup = new TaskGroupAPI.TaskGroup(this._client);
-  findall: FindallAPI.Findall = new FindallAPI.Findall(this._client);
+  findall: FindAllAPI.FindAll = new FindAllAPI.FindAll(this._client);
 
   /**
    * Extracts relevant content from specific web URLs.
@@ -108,9 +107,17 @@ export interface ExcerptSettings {
   /**
    * Optional upper bound on the total number of characters to include per url.
    * Excerpts may contain fewer characters than this limit to maximize relevance and
-   * token efficiency.
+   * token efficiency, but will never contain fewer than 1000 characters per result.
    */
   max_chars_per_result?: number | null;
+
+  /**
+   * Optional upper bound on the total number of characters to include across all
+   * urls. Results may contain fewer characters than this limit to maximize relevance
+   * and token efficiency, but will never contain fewer than 1000 characters per
+   * result.This overall limit applies in addition to max_chars_per_result.
+   */
+  max_chars_total?: number | null;
 }
 
 /**
@@ -288,6 +295,11 @@ export interface BetaExtractParams {
    */
   urls: Array<string>;
 
+  /**
+   * Header param: Optional header to specify the beta version(s) to enable.
+   */
+  betas: Array<TaskRunAPI.ParallelBeta>;
+
   /**
    * Body param: Include excerpts from each URL relevant to the search objective and
    * queries. Note that if neither objective nor search_queries is provided, excerpts
@@ -317,11 +329,6 @@ export interface BetaExtractParams {
    * search queries.
    */
   search_queries?: Array<string> | null;
-
-  /**
-   * Header param: Optional header to specify the beta version(s) to enable.
-   */
-  betas?: Array<TaskRunAPI.ParallelBeta>;
 }
 
 export namespace BetaExtractParams {
@@ -340,7 +347,7 @@ export namespace BetaExtractParams {
 
 export interface BetaSearchParams {
   /**
-   * Body param: Optional settings for returning relevant excerpts.
+   * Body param: Optional settings to configure excerpt generation.
    */
   excerpts?: ExcerptSettings;
 
@@ -401,7 +408,7 @@ export interface BetaSearchParams {
 }
 
 Beta.TaskRun = TaskRun;
-Beta.Findall = Findall;
+Beta.FindAll = FindAll;
 
 export declare namespace Beta {
   export {
@@ -445,28 +452,27 @@ export declare namespace Beta {
   };
 
   export {
-    Findall as Findall,
-    type FindallCandidateMatchStatusEvent as FindallCandidateMatchStatusEvent,
-    type FindallEnrichInput as FindallEnrichInput,
-    type FindallExtendInput as FindallExtendInput,
-    type FindallRun as FindallRun,
-    type FindallRunInput as FindallRunInput,
-    type FindallRunResult as FindallRunResult,
-    type FindallRunStatusEvent as FindallRunStatusEvent,
-    type FindallSchema as FindallSchema,
-    type FindallSchemaUpdatedEvent as FindallSchemaUpdatedEvent,
+    FindAll as FindAll,
+    type FindAllCandidateMatchStatusEvent as FindAllCandidateMatchStatusEvent,
+    type FindAllEnrichInput as FindAllEnrichInput,
+    type FindAllExtendInput as FindAllExtendInput,
+    type FindAllRun as FindAllRun,
+    type FindAllRunInput as FindAllRunInput,
+    type FindAllRunResult as FindAllRunResult,
+    type FindAllRunStatusEvent as FindAllRunStatusEvent,
+    type FindAllSchema as FindAllSchema,
+    type FindAllSchemaUpdatedEvent as FindAllSchemaUpdatedEvent,
     type IngestInput as IngestInput,
-    type FindallRetrieveResponse as FindallRetrieveResponse,
-    type FindallCancelResponse as FindallCancelResponse,
-    type FindallEventsResponse as FindallEventsResponse,
-    type FindallCreateParams as FindallCreateParams,
-    type FindallRetrieveParams as FindallRetrieveParams,
-    type FindallCancelParams as FindallCancelParams,
-    type FindallEnrichParams as FindallEnrichParams,
-    type FindallEventsParams as FindallEventsParams,
-    type FindallExtendParams as FindallExtendParams,
-    type FindallIngestParams as FindallIngestParams,
-    type FindallResultParams as FindallResultParams,
-    type FindallSchemaParams as FindallSchemaParams,
+    type FindAllCancelResponse as FindAllCancelResponse,
+    type FindAllEventsResponse as FindAllEventsResponse,
+    type FindAllCreateParams as FindAllCreateParams,
+    type FindAllRetrieveParams as FindAllRetrieveParams,
+    type FindAllCancelParams as FindAllCancelParams,
+    type FindAllEnrichParams as FindAllEnrichParams,
+    type FindAllEventsParams as FindAllEventsParams,
+    type FindAllExtendParams as FindAllExtendParams,
+    type FindAllIngestParams as FindAllIngestParams,
+    type FindAllResultParams as FindAllResultParams,
+    type FindAllSchemaParams as FindAllSchemaParams,
   };
 }