Merge pull request #24 from onkernel/release-please--branches--main--changes--next--components--sdk

rgarcia · web-flow · commit b9cad84bccb6 · 2025-06-05T10:38:56.000-04:00
release: 0.5.0
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,3 +1,3 @@
 {
-  ".": "0.4.0"
+  ".": "0.5.0"
 }
diff --git a/.stats.yml b/.stats.yml
@@ -1,4 +1,4 @@
 configured_endpoints: 11
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-64ccdff4ca5d73d79d89e817fe83ccfd3d529696df3e6818c3c75e586ae00801.yml
-openapi_spec_hash: 21c7b8757fc0cc9415cda1bc06251de6
-config_hash: b3fcacd707da56b21d31ce0baf4fb87d
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-4502c65bef0843a6ae96d23bba075433af6bab49b55b544b1522f63e7881c00c.yml
+openapi_spec_hash: 3e67b77bbc8cd6155b8f66f3271f2643
+config_hash: c6bab7ac8da570a5abbcfb19db119b6b
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,30 @@
 # Changelog
 
+## 0.5.0 (2025-06-04)
+
+Full Changelog: [v0.4.0...v0.5.0](https://github.com/onkernel/kernel-node-sdk/compare/v0.4.0...v0.5.0)
+
+### Features
+
+* **api:** update via SDK Studio ([8622a14](https://github.com/onkernel/kernel-node-sdk/commit/8622a147a7919f2edd3aa41dfa3ab0a89a7146c8))
+* **api:** update via SDK Studio ([285e2b1](https://github.com/onkernel/kernel-node-sdk/commit/285e2b18ef1458eee08daa75e26ac65884cbac92))
+
+
+### Bug Fixes
+
+* compat with more runtimes ([9862639](https://github.com/onkernel/kernel-node-sdk/commit/98626394921ac1b3ec0b91d4800d0070e90373aa))
+
+
+### Chores
+
+* adjust eslint.config.mjs ignore pattern ([8e7e28a](https://github.com/onkernel/kernel-node-sdk/commit/8e7e28aac90753040d3eb24320c6a758266d4391))
+* **deps:** bump eslint-plugin-prettier ([d3c4417](https://github.com/onkernel/kernel-node-sdk/commit/d3c4417538150b91be13854d837938113ce6a09f))
+* **docs:** use top-level-await in example snippets ([ac334e0](https://github.com/onkernel/kernel-node-sdk/commit/ac334e0fb49f98a15e1318c6754838ae17b036d9))
+* **internal:** codegen related update ([1d16505](https://github.com/onkernel/kernel-node-sdk/commit/1d16505b24c6ee4236cf982ac710bb351006b955))
+* **internal:** fix readablestream types in node 20 ([77cdbc2](https://github.com/onkernel/kernel-node-sdk/commit/77cdbc227d624567aa460e3659bdb30678548a26))
+* **internal:** update jest config ([3248860](https://github.com/onkernel/kernel-node-sdk/commit/3248860f264c1a24c3721eeb5a79c59f6f53dd7f))
+* **internal:** version bump ([870e534](https://github.com/onkernel/kernel-node-sdk/commit/870e534210b2ccdebdbeee4f1346d32bb321c756))
+
 ## 0.4.0 (2025-05-28)
 
 Full Changelog: [v0.3.0...v0.4.0](https://github.com/onkernel/kernel-node-sdk/compare/v0.3.0...v0.4.0)
diff --git a/README.md b/README.md
@@ -27,18 +27,14 @@ const client = new Kernel({
   environment: 'development', // defaults to 'production'
 });
 
-async function main() {
-  const deployment = await client.apps.deployments.create({
-    entrypoint_rel_path: 'main.ts',
-    file: fs.createReadStream('path/to/file'),
-    env_vars: { OPENAI_API_KEY: 'x' },
-    version: '1.0.0',
-  });
-
-  console.log(deployment.apps);
-}
+const deployment = await client.apps.deployments.create({
+  entrypoint_rel_path: 'main.ts',
+  file: fs.createReadStream('path/to/file'),
+  env_vars: { OPENAI_API_KEY: 'x' },
+  version: '1.0.0',
+});
 
-main();
+console.log(deployment.apps);
 ```
 
 ### Request & Response types
@@ -54,15 +50,11 @@ const client = new Kernel({
   environment: 'development', // defaults to 'production'
 });
 
-async function main() {
-  const params: Kernel.BrowserCreateParams = {
-    invocation_id: 'REPLACE_ME',
-    persistence: { id: 'browser-for-user-1234' },
-  };
-  const browser: Kernel.BrowserCreateResponse = await client.browsers.create(params);
-}
-
-main();
+const params: Kernel.BrowserCreateParams = {
+  invocation_id: 'REPLACE_ME',
+  persistence: { id: 'browser-for-user-1234' },
+};
+const browser: Kernel.BrowserCreateResponse = await client.browsers.create(params);
 ```
 
 Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
@@ -119,21 +111,17 @@ a subclass of `APIError` will be thrown:
 
 <!-- prettier-ignore -->
 ```ts
-async function main() {
-  const browser = await client.browsers
-    .create({ invocation_id: 'REPLACE_ME', persistence: { id: 'browser-for-user-1234' } })
-    .catch(async (err) => {
-      if (err instanceof Kernel.APIError) {
-        console.log(err.status); // 400
-        console.log(err.name); // BadRequestError
-        console.log(err.headers); // {server: 'nginx', ...}
-      } else {
-        throw err;
-      }
-    });
-}
-
-main();
+const browser = await client.browsers
+  .create({ invocation_id: 'REPLACE_ME', persistence: { id: 'browser-for-user-1234' } })
+  .catch(async (err) => {
+    if (err instanceof Kernel.APIError) {
+      console.log(err.status); // 400
+      console.log(err.name); // BadRequestError
+      console.log(err.headers); // {server: 'nginx', ...}
+    } else {
+      throw err;
+    }
+  });
 ```
 
 Error codes are as follows:
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -10,7 +10,7 @@ export default tseslint.config(
       parserOptions: { sourceType: 'module' },
     },
     files: ['**/*.ts', '**/*.mts', '**/*.cts', '**/*.js', '**/*.mjs', '**/*.cjs'],
-    ignores: ['dist/**'],
+    ignores: ['dist/'],
     plugins: {
       '@typescript-eslint': tseslint.plugin,
       'unused-imports': unusedImports,
diff --git a/jest.config.ts b/jest.config.ts
@@ -15,6 +15,7 @@ const config: JestConfigWithTsJest = {
     '<rootDir>/dist/',
     '<rootDir>/deno/',
     '<rootDir>/deno_tests/',
+    '<rootDir>/packages/',
   ],
   testPathIgnorePatterns: ['scripts'],
 };
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@onkernel/sdk",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "The official TypeScript library for the Kernel API",
   "author": "Kernel <>",
   "types": "dist/index.d.ts",
@@ -34,7 +34,7 @@
     "@typescript-eslint/eslint-plugin": "8.31.1",
     "@typescript-eslint/parser": "8.31.1",
     "eslint": "^9.20.1",
-    "eslint-plugin-prettier": "^5.2.3",
+    "eslint-plugin-prettier": "^5.4.1",
     "eslint-plugin-unused-imports": "^4.1.4",
     "iconv-lite": "^0.6.3",
     "jest": "^29.4.0",
@@ -46,9 +46,6 @@
     "tsconfig-paths": "^4.0.0",
     "typescript": "5.8.3"
   },
-  "resolutions": {
-    "synckit": "0.8.8"
-  },
   "imports": {
     "@onkernel/sdk": ".",
     "@onkernel/sdk/*": "./src/*"
diff --git a/scripts/build b/scripts/build
@@ -37,8 +37,6 @@ npm exec tsc-multi
 # when building .mjs
 node scripts/utils/fix-index-exports.cjs
 cp tsconfig.dist-src.json dist/src/tsconfig.json
-cp src/internal/shim-types.d.ts dist/internal/shim-types.d.ts
-cp src/internal/shim-types.d.ts dist/internal/shim-types.d.mts
 
 node scripts/utils/postprocess-files.cjs
 
diff --git a/src/internal/detect-platform.ts b/src/internal/detect-platform.ts
@@ -85,10 +85,10 @@ const getPlatformProperties = (): PlatformProperties => {
     return {
       'X-Stainless-Lang': 'js',
       'X-Stainless-Package-Version': VERSION,
-      'X-Stainless-OS': normalizePlatform((globalThis as any).process.platform),
-      'X-Stainless-Arch': normalizeArch((globalThis as any).process.arch),
+      'X-Stainless-OS': normalizePlatform((globalThis as any).process.platform ?? 'unknown'),
+      'X-Stainless-Arch': normalizeArch((globalThis as any).process.arch ?? 'unknown'),
       'X-Stainless-Runtime': 'node',
-      'X-Stainless-Runtime-Version': (globalThis as any).process.version,
+      'X-Stainless-Runtime-Version': (globalThis as any).process.version ?? 'unknown',
     };
   }
 
diff --git a/src/internal/shim-types.d.ts b/src/internal/shim-types.d.ts
diff --git a/src/internal/shim-types.ts b/src/internal/shim-types.ts
@@ -0,0 +1,26 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+/**
+ * Shims for types that we can't always rely on being available globally.
+ *
+ * Note: these only exist at the type-level, there is no corresponding runtime
+ * version for any of these symbols.
+ */
+
+type NeverToAny<T> = T extends never ? any : T;
+
+/** @ts-ignore */
+type _DOMReadableStream<R = any> = globalThis.ReadableStream<R>;
+
+/** @ts-ignore */
+type _NodeReadableStream<R = any> = import('stream/web').ReadableStream<R>;
+
+type _ConditionalNodeReadableStream<R = any> =
+  typeof globalThis extends { ReadableStream: any } ? never : _NodeReadableStream<R>;
+
+type _ReadableStream<R = any> = NeverToAny<
+  | ([0] extends [1 & _DOMReadableStream<R>] ? never : _DOMReadableStream<R>)
+  | ([0] extends [1 & _ConditionalNodeReadableStream<R>] ? never : _ConditionalNodeReadableStream<R>)
+>;
+
+export type { _ReadableStream as ReadableStream };
diff --git a/src/internal/shims.ts b/src/internal/shims.ts
@@ -7,8 +7,8 @@
  * messages in cases where an environment isn't fully supported.
  */
 
-import { type Fetch } from './builtin-types';
-import { type ReadableStream } from './shim-types';
+import type { Fetch } from './builtin-types';
+import type { ReadableStream } from './shim-types';
 
 export function getDefaultFetch(): Fetch {
   if (typeof fetch !== 'undefined') {
diff --git a/src/resources/apps/apps.ts b/src/resources/apps/apps.ts
@@ -25,8 +25,7 @@ export class Apps extends APIResource {
   invocations: InvocationsAPI.Invocations = new InvocationsAPI.Invocations(this._client);
 
   /**
-   * List application versions for the authenticated user. Optionally filter by app
-   * name and/or version label.
+   * List applications. Optionally filter by app name and/or version label.
    *
    * @example
    * ```ts
diff --git a/src/resources/apps/deployments.ts b/src/resources/apps/deployments.ts
@@ -11,7 +11,7 @@ import { path } from '../../internal/utils/path';
 
 export class Deployments extends APIResource {
   /**
-   * Deploy a new application
+   * Deploy a new application and associated actions to Kernel.
    *
    * @example
    * ```ts
diff --git a/src/resources/apps/invocations.ts b/src/resources/apps/invocations.ts
@@ -7,7 +7,7 @@ import { path } from '../../internal/utils/path';
 
 export class Invocations extends APIResource {
   /**
-   * Invoke an application
+   * Invoke an action.
    *
    * @example
    * ```ts
@@ -23,7 +23,7 @@ export class Invocations extends APIResource {
   }
 
   /**
-   * Get an app invocation by id
+   * Get details about an invocation's status and output.
    *
    * @example
    * ```ts
@@ -37,7 +37,7 @@ export class Invocations extends APIResource {
   }
 
   /**
-   * Update invocation status or output
+   * Update an invocation's status or output.
    *
    * @example
    * ```ts
diff --git a/src/resources/browsers.ts b/src/resources/browsers.ts
@@ -9,7 +9,7 @@ import { path } from '../internal/utils/path';
 
 export class Browsers extends APIResource {
   /**
-   * Create Browser Session
+   * Create a new browser session from within an action.
    *
    * @example
    * ```ts
@@ -23,7 +23,7 @@ export class Browsers extends APIResource {
   }
 
   /**
-   * Get Browser Session by ID
+   * Get information about a browser session.
    *
    * @example
    * ```ts
@@ -37,7 +37,7 @@ export class Browsers extends APIResource {
   }
 
   /**
-   * List active browser sessions for the authenticated user
+   * List active browser sessions
    *
    * @example
    * ```ts
@@ -49,7 +49,7 @@ export class Browsers extends APIResource {
   }
 
   /**
-   * Delete a persistent browser session by persistent_id query parameter.
+   * Delete a persistent browser session by its persistent_id.
    *
    * @example
    * ```ts
@@ -68,7 +68,7 @@ export class Browsers extends APIResource {
   }
 
   /**
-   * Delete Browser Session by ID
+   * Delete a browser session by ID
    *
    * @example
    * ```ts
@@ -175,6 +175,12 @@ export interface BrowserCreateParams {
    * Optional persistence configuration for the browser session.
    */
   persistence?: BrowserPersistence;
+
+  /**
+   * If true, launches the browser in stealth mode to reduce detection by anti-bot
+   * mechanisms.
+   */
+  stealth?: boolean;
 }
 
 export interface BrowserDeleteParams {
diff --git a/src/version.ts b/src/version.ts
@@ -1 +1 @@
-export const VERSION = '0.4.0'; // x-release-please-version
+export const VERSION = '0.5.0'; // x-release-please-version
diff --git a/tests/api-resources/browsers.test.ts b/tests/api-resources/browsers.test.ts
@@ -25,6 +25,7 @@ describe('resource browsers', () => {
     const response = await client.browsers.create({
       invocation_id: 'rr33xuugxj9h0bkf1rdt2bet',
       persistence: { id: 'my-awesome-browser-for-user-1234' },
+      stealth: true,
     });
   });
 
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- ".": "0.4.0"`
	`2`	`+ ".": "0.5.0"`
`3`	`3`	`}`