diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 7b51ca0..5e39b94 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.17.0" + ".": "0.18.0" } diff --git a/.stats.yml b/.stats.yml index 8cf9ee7..9e4dbe6 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 65 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-e914e2d08b888c77051acb09176d5e88052f130e0d22e85d946a675d2c3d39ab.yml -openapi_spec_hash: 611d0ed1b4519331470b5d14e5f6784a -config_hash: 3ded7a0ed77b1bfd68eabc6763521fe8 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-015c11efc34c81d4d82a937c017f5eb789ea3ca21a05b70e2ed31c069b839293.yml +openapi_spec_hash: 3dcab2044da305f376cecf4eca38caee +config_hash: 0fbdda3a736cc2748ca33371871e61b3 diff --git a/CHANGELOG.md b/CHANGELOG.md index 460bdec..52526c5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 0.18.0 (2025-10-30) + +Full Changelog: [v0.17.0...v0.18.0](https://github.com/onkernel/kernel-node-sdk/compare/v0.17.0...v0.18.0) + +### Features + +* apps: add offset pagination + headers ([7c91210](https://github.com/onkernel/kernel-node-sdk/commit/7c912109b90c18481e45a5c6d5f367afca039d23)) + ## 0.17.0 (2025-10-27) Full Changelog: [v0.16.0...v0.17.0](https://github.com/onkernel/kernel-node-sdk/compare/v0.16.0...v0.17.0) diff --git a/api.md b/api.md index 3899a03..15db545 100644 --- a/api.md +++ b/api.md @@ -34,7 +34,7 @@ Types: Methods: -- client.apps.list({ ...params }) -> AppListResponse +- client.apps.list({ ...params }) -> AppListResponsesOffsetPagination # Invocations diff --git a/package.json b/package.json index e8752f3..af60924 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@onkernel/sdk", - "version": "0.17.0", + "version": "0.18.0", "description": "The official TypeScript library for the Kernel API", "author": "Kernel <>", "types": "dist/index.d.ts", diff --git a/src/client.ts b/src/client.ts index 5497543..847f278 100644 --- a/src/client.ts +++ b/src/client.ts @@ -18,7 +18,7 @@ import { AbstractPage, type OffsetPaginationParams, OffsetPaginationResponse } f import * as Uploads from './core/uploads'; import * as API from './resources/index'; import { APIPromise } from './core/api-promise'; -import { AppListParams, AppListResponse, Apps } from './resources/apps'; +import { AppListParams, AppListResponse, AppListResponsesOffsetPagination, Apps } from './resources/apps'; import { DeploymentCreateParams, DeploymentCreateResponse, @@ -873,7 +873,12 @@ export declare namespace Kernel { type DeploymentFollowParams as DeploymentFollowParams, }; - export { Apps as Apps, type AppListResponse as AppListResponse, type AppListParams as AppListParams }; + export { + Apps as Apps, + type AppListResponse as AppListResponse, + type AppListResponsesOffsetPagination as AppListResponsesOffsetPagination, + type AppListParams as AppListParams, + }; export { Invocations as Invocations, diff --git a/src/resources/apps.ts b/src/resources/apps.ts index b1b7145..c523e2b 100644 --- a/src/resources/apps.ts +++ b/src/resources/apps.ts @@ -2,63 +2,64 @@ import { APIResource } from '../core/resource'; import * as Shared from './shared'; -import { APIPromise } from '../core/api-promise'; +import { OffsetPagination, type OffsetPaginationParams, PagePromise } from '../core/pagination'; import { RequestOptions } from '../internal/request-options'; export class Apps extends APIResource { /** * List applications. Optionally filter by app name and/or version label. */ - list(query: AppListParams | null | undefined = {}, options?: RequestOptions): APIPromise { - return this._client.get('/apps', { query, ...options }); + list( + query: AppListParams | null | undefined = {}, + options?: RequestOptions, + ): PagePromise { + return this._client.getAPIList('/apps', OffsetPagination, { query, ...options }); } } -export type AppListResponse = Array; +export type AppListResponsesOffsetPagination = OffsetPagination; -export namespace AppListResponse { +/** + * Summary of an application version. + */ +export interface AppListResponse { /** - * Summary of an application version. + * Unique identifier for the app version */ - export interface AppListResponseItem { - /** - * Unique identifier for the app version - */ - id: string; + id: string; - /** - * List of actions available on the app - */ - actions: Array; + /** + * List of actions available on the app + */ + actions: Array; - /** - * Name of the application - */ - app_name: string; + /** + * Name of the application + */ + app_name: string; - /** - * Deployment ID - */ - deployment: string; + /** + * Deployment ID + */ + deployment: string; - /** - * Environment variables configured for this app version - */ - env_vars: { [key: string]: string }; + /** + * Environment variables configured for this app version + */ + env_vars: { [key: string]: string }; - /** - * Deployment region code - */ - region: 'aws.us-east-1a'; + /** + * Deployment region code + */ + region: 'aws.us-east-1a'; - /** - * Version label for the application - */ - version: string; - } + /** + * Version label for the application + */ + version: string; } -export interface AppListParams { +export interface AppListParams extends OffsetPaginationParams { /** * Filter results by application name. */ @@ -71,5 +72,9 @@ export interface AppListParams { } export declare namespace Apps { - export { type AppListResponse as AppListResponse, type AppListParams as AppListParams }; + export { + type AppListResponse as AppListResponse, + type AppListResponsesOffsetPagination as AppListResponsesOffsetPagination, + type AppListParams as AppListParams, + }; } diff --git a/src/resources/index.ts b/src/resources/index.ts index 83e4312..d7e326c 100644 --- a/src/resources/index.ts +++ b/src/resources/index.ts @@ -1,7 +1,12 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. export * from './shared'; -export { Apps, type AppListResponse, type AppListParams } from './apps'; +export { + Apps, + type AppListResponse, + type AppListParams, + type AppListResponsesOffsetPagination, +} from './apps'; export { Browsers, type BrowserPersistence, diff --git a/src/version.ts b/src/version.ts index 0251da7..74131f9 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export const VERSION = '0.17.0'; // x-release-please-version +export const VERSION = '0.18.0'; // x-release-please-version diff --git a/tests/api-resources/apps.test.ts b/tests/api-resources/apps.test.ts index 36a0654..85debc7 100644 --- a/tests/api-resources/apps.test.ts +++ b/tests/api-resources/apps.test.ts @@ -24,7 +24,10 @@ describe('resource apps', () => { test.skip('list: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error await expect( - client.apps.list({ app_name: 'app_name', version: 'version' }, { path: '/_stainless_unknown_path' }), + client.apps.list( + { app_name: 'app_name', limit: 1, offset: 0, version: 'version' }, + { path: '/_stainless_unknown_path' }, + ), ).rejects.toThrow(Kernel.NotFoundError); }); });