Merge pull request #1558 from openai/release-please--branches--master--changes--next--components--openai

release: 5.8.1

Author: kwhinnery-openai

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "5.8.0"
+  ".": "5.8.1"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 111
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-cca460eaf5cc13e9d6e5293eb97aac53d66dc1385c691f74b768c97d165b6e8b.yml
-openapi_spec_hash: 9ec43d443b3dd58ca5aa87eb0a7eb49f
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-a473967d1766dc155994d932fbc4a5bcbd1c140a37c20d0a4065e1bf0640536d.yml
+openapi_spec_hash: 67cdc62b0d6c8b1de29b7dc54b265749
 config_hash: e74d6791681e3af1b548748ff47a22c2

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 5.8.1 (2025-06-26)
+
+Full Changelog: [v5.8.0...v5.8.1](https://github.com/openai/openai-node/compare/v5.8.0...v5.8.1)
+
+### Bug Fixes
+
+* **client:** ensure addOutputText is called on responses.retrieve ([d55bb64](https://github.com/openai/openai-node/commit/d55bb64f8022c1e861b4b4d1c23ad4cc0e80e536))
+
+
+### Chores
+
+* **api:** remove unsupported property ([1966954](https://github.com/openai/openai-node/commit/19669545157dc0339f4c88855bd1ae9acaaac53d))
+* **docs:** update README to include links to docs on Webhooks ([586d5da](https://github.com/openai/openai-node/commit/586d5daf5babc9f12793201f1e1e4c79829151f0))
+* **webhooks:** make private methods really private ([0ee396a](https://github.com/openai/openai-node/commit/0ee396a2a0e03c794c7cfa3c9f1beb848fd77f1d))
+
 ## 5.8.0 (2025-06-26)
 
 Full Changelog: [v5.7.0...v5.8.0](https://github.com/openai/openai-node/compare/v5.7.0...v5.8.0)

README.md

@@ -128,6 +128,8 @@ await client.files.create({
 
 Verifying webhook signatures is _optional but encouraged_.
 
+For more information about webhooks, see [the API docs](https://platform.openai.com/docs/guides/webhooks).
+
 ### Parsing webhook payloads
 
 For most use cases, you will likely want to verify the webhook and parse the payload at the same time. To achieve this, we provide the method `client.webhooks.unwrap()`, which parses a webhook request and verifies that it was sent by OpenAI. This method will throw an error if the signature is invalid.

jsr.json

@@ -1,6 +1,6 @@
 {
   "name": "@openai/openai",
-  "version": "5.8.0",
+  "version": "5.8.1",
   "exports": {
     ".": "./index.ts",
     "./helpers/zod": "./helpers/zod.ts",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "5.8.0",
+  "version": "5.8.1",
   "description": "The official TypeScript library for the OpenAI API",
   "author": "OpenAI <[email protected]>",
   "types": "dist/index.d.ts",

src/resources/responses/responses.ts

@@ -132,10 +132,18 @@ export class Responses extends APIResource {
     query: ResponseRetrieveParams | undefined = {},
     options?: RequestOptions,
   ): APIPromise<Response> | APIPromise<Stream<ResponseStreamEvent>> {
-    return this._client.get(path`/responses/${responseID}`, {
-      query,
-      ...options,
-      stream: query?.stream ?? false,
+    return (
+      this._client.get(path`/responses/${responseID}`, {
+        query,
+        ...options,
+        stream: query?.stream ?? false,
+      }) as APIPromise<Response> | APIPromise<Stream<ResponseStreamEvent>>
+    )._thenUnwrap((rsp) => {
+      if ('object' in rsp && rsp.object === 'response') {
+        addOutputText(rsp as Response);
+      }
+
+      return rsp;
     }) as APIPromise<Response> | APIPromise<Stream<ResponseStreamEvent>>;
   }
 
@@ -1731,6 +1739,58 @@ export interface ResponseFunctionWebSearch {
   type: 'web_search_call';
 }
 
+export namespace ResponseFunctionWebSearch {
+  /**
+   * Action type "search" - Performs a web search query.
+   */
+  export interface Search {
+    /**
+     * The search query.
+     */
+    query: string;
+
+    /**
+     * The action type.
+     */
+    type: 'search';
+  }
+
+  /**
+   * Action type "open_page" - Opens a specific URL from search results.
+   */
+  export interface OpenPage {
+    /**
+     * The action type.
+     */
+    type: 'open_page';
+
+    /**
+     * The URL opened by the model.
+     */
+    url: string;
+  }
+
+  /**
+   * Action type "find": Searches for a pattern within a loaded page.
+   */
+  export interface Find {
+    /**
+     * The pattern or text to search for within the page.
+     */
+    pattern: string;
+
+    /**
+     * The action type.
+     */
+    type: 'find';
+
+    /**
+     * The URL of the page searched for the pattern.
+     */
+    url: string;
+  }
+}
+
 /**
  * Emitted when an image generation tool call has completed and the final image is
  * available.

src/resources/webhooks.ts

@@ -19,28 +19,6 @@ export class Webhooks extends APIResource {
     return JSON.parse(payload) as UnwrapWebhookEvent;
   }
 
-  private validateSecret(secret: string | null | undefined): asserts secret is string {
-    if (typeof secret !== 'string' || secret.length === 0) {
-      throw new Error(
-        `The webhook secret must either be set using the env var, OPENAI_WEBHOOK_SECRET, on the client class, OpenAI({ webhookSecret: '123' }), or passed to this function`,
-      );
-    }
-  }
-
-  private getRequiredHeader(headers: Headers, name: string): string {
-    if (!headers) {
-      throw new Error(`Headers are required`);
-    }
-
-    const value = headers.get(name);
-
-    if (value === null || value === undefined) {
-      throw new Error(`Missing required header: ${name}`);
-    }
-
-    return value;
-  }
-
   /**
    * Validates whether or not the webhook payload was sent by OpenAI.
    *
@@ -65,12 +43,12 @@ export class Webhooks extends APIResource {
       throw new Error('Webhook signature verification is only supported when the `crypto` global is defined');
     }
 
-    this.validateSecret(secret);
+    this.#validateSecret(secret);
 
     const headersObj = buildHeaders([headers]).values;
-    const signatureHeader = this.getRequiredHeader(headersObj, 'webhook-signature');
-    const timestamp = this.getRequiredHeader(headersObj, 'webhook-timestamp');
-    const webhookId = this.getRequiredHeader(headersObj, 'webhook-id');
+    const signatureHeader = this.#getRequiredHeader(headersObj, 'webhook-signature');
+    const timestamp = this.#getRequiredHeader(headersObj, 'webhook-timestamp');
+    const webhookId = this.#getRequiredHeader(headersObj, 'webhook-id');
 
     // Validate timestamp to prevent replay attacks
     const timestampSeconds = parseInt(timestamp, 10);
@@ -137,6 +115,28 @@ export class Webhooks extends APIResource {
       'The given webhook signature does not match the expected signature',
     );
   }
+
+  #validateSecret(secret: string | null | undefined): asserts secret is string {
+    if (typeof secret !== 'string' || secret.length === 0) {
+      throw new Error(
+        `The webhook secret must either be set using the env var, OPENAI_WEBHOOK_SECRET, on the client class, OpenAI({ webhookSecret: '123' }), or passed to this function`,
+      );
+    }
+  }
+
+  #getRequiredHeader(headers: Headers, name: string): string {
+    if (!headers) {
+      throw new Error(`Headers are required`);
+    }
+
+    const value = headers.get(name);
+
+    if (value === null || value === undefined) {
+      throw new Error(`Missing required header: ${name}`);
+    }
+
+    return value;
+  }
 }
 
 /**

src/version.ts

@@ -1 +1 @@
-export const VERSION = '5.8.0'; // x-release-please-version
+export const VERSION = '5.8.1'; // x-release-please-version

tests/api-resources/responses/responses.test.ts

@@ -17,6 +17,9 @@ describe('resource responses', () => {
     const dataAndResponse = await responsePromise.withResponse();
     expect(dataAndResponse.data).toBe(response);
     expect(dataAndResponse.response).toBe(rawResponse);
+
+    expect(response).toHaveProperty('output_text');
+    expect(typeof response.output_text).toBe('string');
   });
 
   test('retrieve', async () => {
@@ -28,6 +31,9 @@ describe('resource responses', () => {
     const dataAndResponse = await responsePromise.withResponse();
     expect(dataAndResponse.data).toBe(response);
     expect(dataAndResponse.response).toBe(rawResponse);
+
+    expect(response).toHaveProperty('output_text');
+    expect(typeof response.output_text).toBe('string');
   });
 
   test('retrieve: request options and params are passed correctly', async () => {