release: 4.26.1

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "4.26.0"
+  ".": "4.26.1"
 }

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 4.26.1 (2024-02-05)
+
+Full Changelog: [v4.26.0...v4.26.1](https://github.com/openai/openai-node/compare/v4.26.0...v4.26.1)
+
+### Chores
+
+* **internal:** enable building when git installed ([#657](https://github.com/openai/openai-node/issues/657)) ([8c80a7d](https://github.com/openai/openai-node/commit/8c80a7d6d36155901a19d1f9cd1fec17b89e261e))
+* **internal:** re-order pagination import ([#656](https://github.com/openai/openai-node/issues/656)) ([21ae54e](https://github.com/openai/openai-node/commit/21ae54ea2cc2779e440909782a6ac8b70f88ec1f))
+* **internal:** support pre-release versioning ([#653](https://github.com/openai/openai-node/issues/653)) ([0c3859f](https://github.com/openai/openai-node/commit/0c3859f88164ae3eb6ec8c29e8889a50861cb35b))
+* **test:** add delay between ecosystem tests retry ([#651](https://github.com/openai/openai-node/issues/651)) ([6a4cc5c](https://github.com/openai/openai-node/commit/6a4cc5cea36ae408c8c1eb2ea0ea02f96ffb77b7))
+
+
+### Documentation
+
+* add a CONTRIBUTING.md ([#659](https://github.com/openai/openai-node/issues/659)) ([8ea58b0](https://github.com/openai/openai-node/commit/8ea58b0b9e7382a3b3af852a9a3a288a485ad33a))
+
 ## 4.26.0 (2024-01-25)
 
 Full Changelog: [v4.25.0...v4.26.0](https://github.com/openai/openai-node/compare/v4.25.0...v4.26.0)

CONTRIBUTING.md

@@ -0,0 +1,107 @@
+## Setting up the environment
+
+This repository uses [`yarn@v1`](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable).
+Other package managers may work but are not officially supported for development.
+
+To setup the repository, run:
+
+```bash
+yarn
+yarn build
+```
+
+This will install all the required dependencies and build output files to `dist/`.
+
+## Modifying/Adding code
+
+Most of the SDK is generated code, and any modified code will be overridden on the next generation. The
+`src/lib/` and `examples/` directories are exceptions and will never be overridden.
+
+## Adding and running examples
+
+All files in the `examples/` directory are not modified by the Stainless generator and can be freely edited or
+added to.
+
+```bash
+// add an example to examples/<your-example>.ts
+
+#!/usr/bin/env -S npm run tsn -T
+…
+```
+
+```
+chmod +x examples/<your-example>.ts
+# run the example against your api
+yarn tsn -T examples/<your-example>.ts
+```
+
+## Using the repository from source
+
+If you’d like to use the repository from source, you can either install from git or link to a cloned repository:
+
+To install via git:
+
+```bash
+npm install --save git+ssh://[email protected]:openai/openai-node.git
+```
+
+Alternatively, to link a local copy of the repo:
+
+```bash
+# Clone
+git clone https://www.github.com/openai/openai-node
+cd openai-node
+
+# With yarn
+yarn link
+cd ../my-package
+yarn link openai
+
+# With pnpm
+pnpm link --global
+cd ../my-package
+pnpm link -—global openai
+```
+
+## Running tests
+
+Most tests will require you to [setup a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests.
+
+```bash
+npx prism path/to/your/openapi.yml
+```
+
+```bash
+yarn run test
+```
+
+## Linting and formatting
+
+This repository uses [prettier](https://www.npmjs.com/package/prettier) and
+[eslint](https://www.npmjs.com/package/eslint) to format the code in the repository.
+
+To lint:
+
+```bash
+yarn lint
+```
+
+To format and fix all lint issues automatically:
+
+```bash
+yarn fix
+```
+
+## Publishing and releases
+
+Changes made to this repository via the automated release PR pipeline should publish to npm automatically. If
+the changes aren't made through the automated pipeline, you may want to make releases manually.
+
+### Publish with a GitHub workflow
+
+You can release to package managers by using [the `Publish NPM` GitHub action](https://www.github.com/openai/openai-node/actions/workflows/publish-npm.yml). This will require a setup organization or repository secret to be set up.
+
+### Publish manually
+
+If you need to manually release a package, you can run the `bin/publish-npm` script with an `NPM_TOKEN` set on
+the environment.

README.md

@@ -21,7 +21,7 @@ You can import in Deno via:
 <!-- x-release-please-start-version -->
 
 ```ts
-import OpenAI from 'https://deno.land/x/[email protected].0/mod.ts';
+import OpenAI from 'https://deno.land/x/[email protected].1/mod.ts';
 ```
 
 <!-- x-release-please-end -->

build-deno

@@ -14,7 +14,7 @@ This is a build produced from https://github.com/openai/openai-node – please g
 Usage:
 
 \`\`\`ts
-import OpenAI from "https://deno.land/x/[email protected].0/mod.ts";
+import OpenAI from "https://deno.land/x/[email protected].1/mod.ts";
 
 const client = new OpenAI();
 \`\`\`

ecosystem-tests/cli.ts

@@ -142,10 +142,15 @@ function parseArgs() {
         description: 'number of parallel jobs to run',
       },
       retry: {
-        type: 'number',
+        type: 'count',
         default: 0,
         description: 'number of times to retry failing jobs',
       },
+      retryDelay: {
+        type: 'number',
+        default: 100,
+        description: 'delay between retries in ms',
+      },
       parallel: {
         type: 'boolean',
         default: false,
@@ -271,7 +276,7 @@ async function main() {
         console.error('\n');
 
         try {
-          await withRetry(fn, project, state.retry);
+          await withRetry(fn, project, state.retry, state.retryDelay);
           console.error('\n');
           console.error(`✅ ${project}`);
         } catch (err) {
@@ -297,13 +302,21 @@ async function main() {
   process.exit(0);
 }
 
-async function withRetry(fn: () => Promise<void>, identifier: string, retryAmount: number): Promise<void> {
+async function withRetry(
+  fn: () => Promise<void>,
+  identifier: string,
+  retryAmount: number,
+  retryDelayMs: number,
+): Promise<void> {
   do {
     try {
       return await fn();
     } catch (err) {
       if (--retryAmount <= 0) throw err;
-      console.error(`${identifier} failed due to ${err}; retries left ${retryAmount}`);
+      console.error(
+        `${identifier} failed due to ${err}; retries left ${retryAmount}, next retry in ${retryDelayMs}ms`,
+      );
+      await new Promise((resolve) => setTimeout(resolve, retryDelayMs));
     }
   } while (retryAmount > 0);
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "4.26.0",
+  "version": "4.26.1",
   "description": "The official TypeScript library for the OpenAI API",
   "author": "OpenAI <[email protected]>",
   "types": "dist/index.d.ts",
@@ -9,14 +9,17 @@
   "repository": "github:openai/openai-node",
   "license": "Apache-2.0",
   "packageManager": "[email protected]",
+  "files": [
+    "*"
+  ],
   "private": false,
   "scripts": {
     "test": "bin/check-test-server && yarn jest",
     "build": "bash ./build",
     "prepack": "echo 'to pack, run yarn build && (cd dist; yarn pack)' && exit 1",
     "prepublishOnly": "echo 'to publish, run yarn build && (cd dist; yarn publish)' && exit 1",
     "format": "prettier --write --cache --cache-strategy metadata . !dist",
-    "prepare": "if [ $(basename $(dirname $PWD)) = 'node_modules' ]; then npm run build; fi",
+    "prepare": "if ./scripts/check-is-in-git-install.sh; then npm run build; fi",
     "tsn": "ts-node -r tsconfig-paths/register",
     "lint": "eslint --ext ts,js .",
     "fix": "eslint --fix --ext ts,js ."

release-please-config.json

@@ -5,6 +5,8 @@
   "$schema": "https://raw.githubusercontent.com/stainless-api/release-please/main/schemas/config.json",
   "include-v-in-tag": true,
   "include-component-in-tag": false,
+  "versioning": "prerelease",
+  "prerelease": true,
   "bump-minor-pre-major": true,
   "bump-patch-for-minor-pre-major": false,
   "pull-request-header": "Automated Release PR",

scripts/check-is-in-git-install.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+# Check if you happen to call prepare for a repository that's already in node_modules.
+[ "$(basename "$(dirname "$PWD")")" = 'node_modules' ] ||
+# The name of the containing directory that 'npm` uses, which looks like
+# $HOME/.npm/_cacache/git-cloneXXXXXX
+[ "$(basename "$(dirname "$PWD")")" = 'tmp' ] ||
+# The name of the containing directory that 'yarn` uses, which looks like
+# $(yarn cache dir)/.tmp/XXXXX
+[ "$(basename "$(dirname "$PWD")")" = '.tmp' ]

src/index.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
 import * as Core from './core';
-import * as Pagination from './pagination';
 import * as Errors from './error';
 import { type Agent } from './_shims/index';
 import * as Uploads from './uploads';
+import * as Pagination from 'openai/pagination';
 import * as API from 'openai/resources/index';
 
 export interface ClientOptions {

src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.26.0'; // x-release-please-version
+export const VERSION = '4.26.1'; // x-release-please-version