feat(api): add IP address logging for residential and custom proxies

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 90
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-6a44c851ec955b997558a8524eb641355ff3097474f40772b8ea2fef5bee4134.yml
-openapi_spec_hash: 155ee005a1b43e1c11e843de91e9f509
-config_hash: 6cbbf855a29bc675f35ddb1106ea9083
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-cc60c65c6bb0b8a8ea662cf758806e641790870ded35f6ffdb9f4801f3d29b15.yml
+openapi_spec_hash: a1074e1bba578bcd5912512166ada0dc
+config_hash: 7868d3397406c2974b6f058488aeefd6

CONTRIBUTING.md

@@ -55,12 +55,12 @@ $ cd kernel-node-sdk
 # With yarn
 $ yarn link
 $ cd ../my-package
-$ yarn link @onkernel/sdk
+$ yarn link @kernel/sdk
 
 # With pnpm
 $ pnpm link --global
 $ cd ../my-package
-$ pnpm link -—global @onkernel/sdk
+$ pnpm link -—global @kernel/sdk
 ```
 
 ## Running tests

README.md

@@ -1,6 +1,6 @@
 # Kernel TypeScript API Library
 
-[![NPM version](<https://img.shields.io/npm/v/@onkernel/sdk.svg?label=npm%20(stable)>)](https://npmjs.org/package/@onkernel/sdk) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@onkernel/sdk)
+[![NPM version](<https://img.shields.io/npm/v/@kernel/sdk.svg?label=npm%20(stable)>)](https://npmjs.org/package/@kernel/sdk) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@kernel/sdk)
 
 This library provides convenient access to the Kernel REST API from server-side TypeScript or JavaScript.
 
@@ -11,7 +11,7 @@ It is generated with [Stainless](https://www.stainless.com/).
 ## Installation
 
 ```sh
-npm install @onkernel/sdk
+npm install @kernel/sdk
 ```
 
 ## Usage
@@ -20,7 +20,7 @@ The full API of this library can be found in [api.md](api.md).
 
 <!-- prettier-ignore -->
 ```js
-import Kernel from '@onkernel/sdk';
+import Kernel from '@kernel/sdk';
 
 const client = new Kernel({
   apiKey: process.env['KERNEL_API_KEY'], // This is the default and can be omitted
@@ -38,7 +38,7 @@ This library includes TypeScript definitions for all request params and response
 
 <!-- prettier-ignore -->
 ```ts
-import Kernel from '@onkernel/sdk';
+import Kernel from '@kernel/sdk';
 
 const client = new Kernel({
   apiKey: process.env['KERNEL_API_KEY'], // This is the default and can be omitted
@@ -62,7 +62,7 @@ Request parameters that correspond to file uploads can be passed in many differe
 
 ```ts
 import fs from 'fs';
-import Kernel, { toFile } from '@onkernel/sdk';
+import Kernel, { toFile } from '@kernel/sdk';
 
 const client = new Kernel();
 
@@ -227,7 +227,7 @@ The log level can be configured in two ways:
 2. Using the `logLevel` client option (overrides the environment variable if set)
 
 ```ts
-import Kernel from '@onkernel/sdk';
+import Kernel from '@kernel/sdk';
 
 const client = new Kernel({
   logLevel: 'debug', // Show all log messages
@@ -255,7 +255,7 @@ When providing a custom logger, the `logLevel` option still controls which messa
 below the configured level will not be sent to your logger.
 
 ```ts
-import Kernel from '@onkernel/sdk';
+import Kernel from '@kernel/sdk';
 import pino from 'pino';
 
 const logger = pino();
@@ -324,7 +324,7 @@ globalThis.fetch = fetch;
 Or pass it to the client:
 
 ```ts
-import Kernel from '@onkernel/sdk';
+import Kernel from '@kernel/sdk';
 import fetch from 'my-fetch';
 
 const client = new Kernel({ fetch });
@@ -335,7 +335,7 @@ const client = new Kernel({ fetch });
 If you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)
 
 ```ts
-import Kernel from '@onkernel/sdk';
+import Kernel from '@kernel/sdk';
 
 const client = new Kernel({
   fetchOptions: {
@@ -352,7 +352,7 @@ options to requests:
 <img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/node.svg" align="top" width="18" height="21"> **Node** <sup>[[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]</sup>
 
 ```ts
-import Kernel from '@onkernel/sdk';
+import Kernel from '@kernel/sdk';
 import * as undici from 'undici';
 
 const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
@@ -366,7 +366,7 @@ const client = new Kernel({
 <img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/bun.svg" align="top" width="18" height="21"> **Bun** <sup>[[docs](https://bun.sh/guides/http/proxy)]</sup>
 
 ```ts
-import Kernel from '@onkernel/sdk';
+import Kernel from '@kernel/sdk';
 
 const client = new Kernel({
   fetchOptions: {
@@ -378,7 +378,7 @@ const client = new Kernel({
 <img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/deno.svg" align="top" width="18" height="21"> **Deno** <sup>[[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]</sup>
 
 ```ts
-import Kernel from 'npm:@onkernel/sdk';
+import Kernel from 'npm:@kernel/sdk';
 
 const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
 const client = new Kernel({

eslint.config.mjs

@@ -25,7 +25,7 @@ export default tseslint.config(
         {
           patterns: [
             {
-              regex: '^@onkernel/sdk(/.*)?',
+              regex: '^@kernel/sdk(/.*)?',
               message: 'Use a relative import, not a package import.',
             },
           ],

jest.config.ts

@@ -7,8 +7,8 @@ const config: JestConfigWithTsJest = {
     '^.+\\.(t|j)sx?$': ['@swc/jest', { sourceMaps: 'inline' }],
   },
   moduleNameMapper: {
-    '^@onkernel/sdk$': '<rootDir>/src/index.ts',
-    '^@onkernel/sdk/(.*)$': '<rootDir>/src/$1',
+    '^@kernel/sdk$': '<rootDir>/src/index.ts',
+    '^@kernel/sdk/(.*)$': '<rootDir>/src/$1',
   },
   modulePathIgnorePatterns: [
     '<rootDir>/ecosystem-tests/',

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@onkernel/sdk",
+  "name": "@kernel/sdk",
   "version": "0.24.0",
   "description": "The official TypeScript library for the Kernel API",
   "author": "Kernel <>",

scripts/build

@@ -8,7 +8,7 @@ node scripts/utils/check-version.cjs
 
 # Build into dist and will publish the package from there,
 # so that src/resources/foo.ts becomes <package root>/resources/foo.js
-# This way importing from `"@onkernel/sdk/resources/foo"` works
+# This way importing from `"@kernel/sdk/resources/foo"` works
 # even with `"moduleResolution": "node"`
 
 rm -rf dist; mkdir dist
@@ -42,8 +42,8 @@ node scripts/utils/postprocess-files.cjs
 
 # make sure that nothing crashes when we require the output CJS or
 # import the output ESM
-(cd dist && node -e 'require("@onkernel/sdk")')
-(cd dist && node -e 'import("@onkernel/sdk")' --input-type=module)
+(cd dist && node -e 'require("@kernel/sdk")')
+(cd dist && node -e 'import("@kernel/sdk")' --input-type=module)
 
 if [ -e ./scripts/build-deno ]
 then

src/client.ts

@@ -112,7 +112,7 @@ import {
 import { isEmptyObj } from './internal/utils/values';
 
 const environments = {
-  production: 'https://api.onkernel.com/',
+  production: 'https://api.kernel.com/',
   development: 'https://localhost:3001/',
 };
 type Environment = keyof typeof environments;
@@ -127,7 +127,7 @@ export interface ClientOptions {
    * Specifies the environment to use for the API.
    *
    * Each environment maps to a different base URL:
-   * - `production` corresponds to `https://api.onkernel.com/`
+   * - `production` corresponds to `https://api.kernel.com/`
    * - `development` corresponds to `https://localhost:3001/`
    */
   environment?: Environment | undefined;
@@ -224,7 +224,7 @@ export class Kernel {
    *
    * @param {string | undefined} [opts.apiKey=process.env['KERNEL_API_KEY'] ?? undefined]
    * @param {Environment} [opts.environment=production] - Specifies the environment URL to use for the API.
-   * @param {string} [opts.baseURL=process.env['KERNEL_BASE_URL'] ?? https://api.onkernel.com/] - Override the default base URL for the API.
+   * @param {string} [opts.baseURL=process.env['KERNEL_BASE_URL'] ?? https://api.kernel.com/] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
    * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.

src/resources/proxies.ts

@@ -68,6 +68,11 @@ export interface ProxyCreateResponse {
     | ProxyCreateResponse.MobileProxyConfig
     | ProxyCreateResponse.CustomProxyConfig;
 
+  /**
+   * IP address that the proxy uses when making requests.
+   */
+  ip_address?: string;
+
   /**
    * Timestamp of the last health check performed on this proxy.
    */
@@ -288,6 +293,11 @@ export interface ProxyRetrieveResponse {
     | ProxyRetrieveResponse.MobileProxyConfig
     | ProxyRetrieveResponse.CustomProxyConfig;
 
+  /**
+   * IP address that the proxy uses when making requests.
+   */
+  ip_address?: string;
+
   /**
    * Timestamp of the last health check performed on this proxy.
    */
@@ -511,6 +521,11 @@ export namespace ProxyListResponse {
       | ProxyListResponseItem.MobileProxyConfig
       | ProxyListResponseItem.CustomProxyConfig;
 
+    /**
+     * IP address that the proxy uses when making requests.
+     */
+    ip_address?: string;
+
     /**
      * Timestamp of the last health check performed on this proxy.
      */
@@ -732,6 +747,11 @@ export interface ProxyCheckResponse {
     | ProxyCheckResponse.MobileProxyConfig
     | ProxyCheckResponse.CustomProxyConfig;
 
+  /**
+   * IP address that the proxy uses when making requests.
+   */
+  ip_address?: string;
+
   /**
    * Timestamp of the last health check performed on this proxy.
    */

tests/api-resources/agents/auth/auth.test.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import Kernel from '@onkernel/sdk';
+import Kernel from '@kernel/sdk';
 
 const client = new Kernel({
   apiKey: 'My API Key',