@onkernel/sdk 0.5.0 → 0.6.0

package/src/internal/utils/values.ts

@@ -9,6 +9,9 @@ export const isAbsoluteURL = (url: string): boolean => {
   return startsWithSchemeRegexp.test(url);
 };
 
+export let isArray = (val: unknown): val is unknown[] => ((isArray = Array.isArray), isArray(val));
+export let isReadonlyArray = isArray as (val: unknown) => val is readonly unknown[];
+
 /** Returns an object if the given value isn't an object, otherwise returns as-is */
 export function maybeObj(x: unknown): object {
   if (typeof x !== 'object') {

package/src/resources/apps/apps.ts

@@ -8,21 +8,11 @@ import {
   DeploymentFollowResponse,
   Deployments,
 } from './deployments';
-import * as InvocationsAPI from './invocations';
-import {
-  InvocationCreateParams,
-  InvocationCreateResponse,
-  InvocationRetrieveResponse,
-  InvocationUpdateParams,
-  InvocationUpdateResponse,
-  Invocations,
-} from './invocations';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 
 export class Apps extends APIResource {
   deployments: DeploymentsAPI.Deployments = new DeploymentsAPI.Deployments(this._client);
-  invocations: InvocationsAPI.Invocations = new InvocationsAPI.Invocations(this._client);
 
   /**
    * List applications. Optionally filter by app name and/or version label.
@@ -57,7 +47,7 @@ export namespace AppListResponse {
     /**
      * Deployment region code
      */
-    region: string;
+    region: 'aws.us-east-1a';
 
     /**
      * Version label for the application
@@ -84,7 +74,6 @@ export interface AppListParams {
 }
 
 Apps.Deployments = Deployments;
-Apps.Invocations = Invocations;
 
 export declare namespace Apps {
   export { type AppListResponse as AppListResponse, type AppListParams as AppListParams };
@@ -95,13 +84,4 @@ export declare namespace Apps {
     type DeploymentFollowResponse as DeploymentFollowResponse,
     type DeploymentCreateParams as DeploymentCreateParams,
   };
-
-  export {
-    Invocations as Invocations,
-    type InvocationCreateResponse as InvocationCreateResponse,
-    type InvocationRetrieveResponse as InvocationRetrieveResponse,
-    type InvocationUpdateResponse as InvocationUpdateResponse,
-    type InvocationCreateParams as InvocationCreateParams,
-    type InvocationUpdateParams as InvocationUpdateParams,
-  };
 }

package/src/resources/apps/deployments.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
 import { APIPromise } from '../../core/api-promise';
 import { Stream } from '../../core/streaming';
 import { type Uploadable } from '../../core/uploads';
@@ -96,7 +97,7 @@ export namespace DeploymentCreateResponse {
 export type DeploymentFollowResponse =
   | DeploymentFollowResponse.StateEvent
   | DeploymentFollowResponse.StateUpdateEvent
-  | DeploymentFollowResponse.LogEvent;
+  | Shared.LogEvent;
 
 export namespace DeploymentFollowResponse {
   /**
@@ -138,26 +139,6 @@ export namespace DeploymentFollowResponse {
      */
     timestamp?: string;
   }
-
-  /**
-   * A log entry from the application.
-   */
-  export interface LogEvent {
-    /**
-     * Event type identifier (always "log").
-     */
-    event: 'log';
-
-    /**
-     * Log message text.
-     */
-    message: string;
-
-    /**
-     * Time the log entry was produced.
-     */
-    timestamp?: string;
-  }
 }
 
 export interface DeploymentCreateParams {

package/src/resources/apps/index.ts

@@ -7,11 +7,3 @@ export {
   type DeploymentFollowResponse,
   type DeploymentCreateParams,
 } from './deployments';
-export {
-  Invocations,
-  type InvocationCreateResponse,
-  type InvocationRetrieveResponse,
-  type InvocationUpdateResponse,
-  type InvocationCreateParams,
-  type InvocationUpdateParams,
-} from './invocations';

package/src/resources/deployments.ts

@@ -0,0 +1,326 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { Stream } from '../core/streaming';
+import { type Uploadable } from '../core/uploads';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { multipartFormRequestOptions } from '../internal/uploads';
+import { path } from '../internal/utils/path';
+
+export class Deployments extends APIResource {
+  /**
+   * Create a new deployment.
+   *
+   * @example
+   * ```ts
+   * const deployment = await client.deployments.create({
+   *   entrypoint_rel_path: 'src/app.py',
+   *   file: fs.createReadStream('path/to/file'),
+   * });
+   * ```
+   */
+  create(body: DeploymentCreateParams, options?: RequestOptions): APIPromise<DeploymentCreateResponse> {
+    return this._client.post('/deployments', multipartFormRequestOptions({ body, ...options }, this._client));
+  }
+
+  /**
+   * Get information about a deployment's status.
+   *
+   * @example
+   * ```ts
+   * const deployment = await client.deployments.retrieve('id');
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<DeploymentRetrieveResponse> {
+    return this._client.get(path`/deployments/${id}`, options);
+  }
+
+  /**
+   * Establishes a Server-Sent Events (SSE) stream that delivers real-time logs and
+   * status updates for a deployment. The stream terminates automatically once the
+   * deployment reaches a terminal state.
+   *
+   * @example
+   * ```ts
+   * const response = await client.deployments.follow('id');
+   * ```
+   */
+  follow(id: string, options?: RequestOptions): APIPromise<Stream<DeploymentFollowResponse>> {
+    return this._client.get(path`/deployments/${id}/events`, {
+      ...options,
+      headers: buildHeaders([{ Accept: 'text/event-stream' }, options?.headers]),
+      stream: true,
+    }) as APIPromise<Stream<DeploymentFollowResponse>>;
+  }
+}
+
+/**
+ * An event representing the current state of a deployment.
+ */
+export interface DeploymentStateEvent {
+  /**
+   * Deployment record information.
+   */
+  deployment: DeploymentStateEvent.Deployment;
+
+  /**
+   * Event type identifier (always "deployment_state").
+   */
+  event: 'deployment_state';
+
+  /**
+   * Time the state was reported.
+   */
+  timestamp: string;
+}
+
+export namespace DeploymentStateEvent {
+  /**
+   * Deployment record information.
+   */
+  export interface Deployment {
+    /**
+     * Unique identifier for the deployment
+     */
+    id: string;
+
+    /**
+     * Timestamp when the deployment was created
+     */
+    created_at: string;
+
+    /**
+     * Deployment region code
+     */
+    region: 'aws.us-east-1a';
+
+    /**
+     * Current status of the deployment
+     */
+    status: 'queued' | 'in_progress' | 'running' | 'failed' | 'stopped';
+
+    /**
+     * Relative path to the application entrypoint
+     */
+    entrypoint_rel_path?: string;
+
+    /**
+     * Environment variables configured for this deployment
+     */
+    env_vars?: Record<string, string>;
+
+    /**
+     * Status reason
+     */
+    status_reason?: string;
+
+    /**
+     * Timestamp when the deployment was last updated
+     */
+    updated_at?: string | null;
+  }
+}
+
+/**
+ * Deployment record information.
+ */
+export interface DeploymentCreateResponse {
+  /**
+   * Unique identifier for the deployment
+   */
+  id: string;
+
+  /**
+   * Timestamp when the deployment was created
+   */
+  created_at: string;
+
+  /**
+   * Deployment region code
+   */
+  region: 'aws.us-east-1a';
+
+  /**
+   * Current status of the deployment
+   */
+  status: 'queued' | 'in_progress' | 'running' | 'failed' | 'stopped';
+
+  /**
+   * Relative path to the application entrypoint
+   */
+  entrypoint_rel_path?: string;
+
+  /**
+   * Environment variables configured for this deployment
+   */
+  env_vars?: Record<string, string>;
+
+  /**
+   * Status reason
+   */
+  status_reason?: string;
+
+  /**
+   * Timestamp when the deployment was last updated
+   */
+  updated_at?: string | null;
+}
+
+/**
+ * Deployment record information.
+ */
+export interface DeploymentRetrieveResponse {
+  /**
+   * Unique identifier for the deployment
+   */
+  id: string;
+
+  /**
+   * Timestamp when the deployment was created
+   */
+  created_at: string;
+
+  /**
+   * Deployment region code
+   */
+  region: 'aws.us-east-1a';
+
+  /**
+   * Current status of the deployment
+   */
+  status: 'queued' | 'in_progress' | 'running' | 'failed' | 'stopped';
+
+  /**
+   * Relative path to the application entrypoint
+   */
+  entrypoint_rel_path?: string;
+
+  /**
+   * Environment variables configured for this deployment
+   */
+  env_vars?: Record<string, string>;
+
+  /**
+   * Status reason
+   */
+  status_reason?: string;
+
+  /**
+   * Timestamp when the deployment was last updated
+   */
+  updated_at?: string | null;
+}
+
+/**
+ * Union type representing any deployment event.
+ */
+export type DeploymentFollowResponse =
+  | Shared.LogEvent
+  | DeploymentStateEvent
+  | DeploymentFollowResponse.AppVersionSummaryEvent
+  | Shared.ErrorEvent;
+
+export namespace DeploymentFollowResponse {
+  /**
+   * Summary of an application version.
+   */
+  export interface AppVersionSummaryEvent {
+    /**
+     * Unique identifier for the app version
+     */
+    id: string;
+
+    /**
+     * List of actions available on the app
+     */
+    actions: Array<AppVersionSummaryEvent.Action>;
+
+    /**
+     * Name of the application
+     */
+    app_name: string;
+
+    /**
+     * Event type identifier (always "app_version_summary").
+     */
+    event: 'app_version_summary';
+
+    /**
+     * Deployment region code
+     */
+    region: 'aws.us-east-1a';
+
+    /**
+     * Time the state was reported.
+     */
+    timestamp: string;
+
+    /**
+     * Version label for the application
+     */
+    version: string;
+
+    /**
+     * Environment variables configured for this app version
+     */
+    env_vars?: Record<string, string>;
+  }
+
+  export namespace AppVersionSummaryEvent {
+    /**
+     * An action available on the app
+     */
+    export interface Action {
+      /**
+       * Name of the action
+       */
+      name: string;
+    }
+  }
+}
+
+export interface DeploymentCreateParams {
+  /**
+   * Relative path to the entrypoint of the application
+   */
+  entrypoint_rel_path: string;
+
+  /**
+   * ZIP file containing the application source directory
+   */
+  file: Uploadable;
+
+  /**
+   * Map of environment variables to set for the deployed application. Each key-value
+   * pair represents an environment variable.
+   */
+  env_vars?: Record<string, string>;
+
+  /**
+   * Allow overwriting an existing app version
+   */
+  force?: boolean;
+
+  /**
+   * Region for deployment. Currently we only support "aws.us-east-1a"
+   */
+  region?: 'aws.us-east-1a';
+
+  /**
+   * Version of the application. Can be any string.
+   */
+  version?: string;
+}
+
+export declare namespace Deployments {
+  export {
+    type DeploymentStateEvent as DeploymentStateEvent,
+    type DeploymentCreateResponse as DeploymentCreateResponse,
+    type DeploymentRetrieveResponse as DeploymentRetrieveResponse,
+    type DeploymentFollowResponse as DeploymentFollowResponse,
+    type DeploymentCreateParams as DeploymentCreateParams,
+  };
+}

package/src/resources/index.ts

@@ -1,5 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export * from './shared';
 export { Apps, type AppListResponse, type AppListParams } from './apps/apps';
 export {
   Browsers,
@@ -10,3 +11,21 @@ export {
   type BrowserCreateParams,
   type BrowserDeleteParams,
 } from './browsers';
+export {
+  Deployments,
+  type DeploymentStateEvent,
+  type DeploymentCreateResponse,
+  type DeploymentRetrieveResponse,
+  type DeploymentFollowResponse,
+  type DeploymentCreateParams,
+} from './deployments';
+export {
+  Invocations,
+  type InvocationStateEvent,
+  type InvocationCreateResponse,
+  type InvocationRetrieveResponse,
+  type InvocationUpdateResponse,
+  type InvocationFollowResponse,
+  type InvocationCreateParams,
+  type InvocationUpdateParams,
+} from './invocations';

package/src/resources/{apps/invocations.ts → invocations.ts}

@@ -1,9 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../core/resource';
-import { APIPromise } from '../../core/api-promise';
-import { RequestOptions } from '../../internal/request-options';
-import { path } from '../../internal/utils/path';
+import { APIResource } from '../core/resource';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { Stream } from '../core/streaming';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
 
 export class Invocations extends APIResource {
   /**
@@ -11,7 +14,7 @@ export class Invocations extends APIResource {
    *
    * @example
    * ```ts
-   * const invocation = await client.apps.invocations.create({
+   * const invocation = await client.invocations.create({
    *   action_name: 'analyze',
    *   app_name: 'my-app',
    *   version: '1.0.0',
@@ -27,7 +30,7 @@ export class Invocations extends APIResource {
    *
    * @example
    * ```ts
-   * const invocation = await client.apps.invocations.retrieve(
+   * const invocation = await client.invocations.retrieve(
    *   'rr33xuugxj9h0bkf1rdt2bet',
    * );
    * ```
@@ -41,10 +44,9 @@ export class Invocations extends APIResource {
    *
    * @example
    * ```ts
-   * const invocation = await client.apps.invocations.update(
-   *   'id',
-   *   { status: 'succeeded' },
-   * );
+   * const invocation = await client.invocations.update('id', {
+   *   status: 'succeeded',
+   * });
    * ```
    */
   update(
@@ -54,6 +56,92 @@ export class Invocations extends APIResource {
   ): APIPromise<InvocationUpdateResponse> {
     return this._client.patch(path`/invocations/${id}`, { body, ...options });
   }
+
+  /**
+   * Establishes a Server-Sent Events (SSE) stream that delivers real-time logs and
+   * status updates for an invocation. The stream terminates automatically once the
+   * invocation reaches a terminal state.
+   *
+   * @example
+   * ```ts
+   * const response = await client.invocations.follow('id');
+   * ```
+   */
+  follow(id: string, options?: RequestOptions): APIPromise<Stream<InvocationFollowResponse>> {
+    return this._client.get(path`/invocations/${id}/events`, {
+      ...options,
+      headers: buildHeaders([{ Accept: 'text/event-stream' }, options?.headers]),
+      stream: true,
+    }) as APIPromise<Stream<InvocationFollowResponse>>;
+  }
+}
+
+/**
+ * An event representing the current state of an invocation.
+ */
+export interface InvocationStateEvent {
+  /**
+   * Event type identifier (always "invocation_state").
+   */
+  event: 'invocation_state';
+
+  invocation: InvocationStateEvent.Invocation;
+
+  /**
+   * Time the state was reported.
+   */
+  timestamp: string;
+}
+
+export namespace InvocationStateEvent {
+  export interface Invocation {
+    /**
+     * ID of the invocation
+     */
+    id: string;
+
+    /**
+     * Name of the action invoked
+     */
+    action_name: string;
+
+    /**
+     * Name of the application
+     */
+    app_name: string;
+
+    /**
+     * RFC 3339 Nanoseconds timestamp when the invocation started
+     */
+    started_at: string;
+
+    /**
+     * Status of the invocation
+     */
+    status: 'queued' | 'running' | 'succeeded' | 'failed';
+
+    /**
+     * RFC 3339 Nanoseconds timestamp when the invocation finished (null if still
+     * running)
+     */
+    finished_at?: string | null;
+
+    /**
+     * Output produced by the action, rendered as a JSON string. This could be: string,
+     * number, boolean, array, object, or null.
+     */
+    output?: string;
+
+    /**
+     * Payload provided to the invocation. This is a string that can be parsed as JSON.
+     */
+    payload?: string;
+
+    /**
+     * Status reason
+     */
+    status_reason?: string;
+  }
 }
 
 export interface InvocationCreateResponse {
@@ -177,6 +265,11 @@ export interface InvocationUpdateResponse {
   status_reason?: string;
 }
 
+/**
+ * Union type representing any invocation event.
+ */
+export type InvocationFollowResponse = Shared.LogEvent | InvocationStateEvent | Shared.ErrorEvent;
+
 export interface InvocationCreateParams {
   /**
    * Name of the action to invoke
@@ -219,9 +312,11 @@ export interface InvocationUpdateParams {
 
 export declare namespace Invocations {
   export {
+    type InvocationStateEvent as InvocationStateEvent,
     type InvocationCreateResponse as InvocationCreateResponse,
     type InvocationRetrieveResponse as InvocationRetrieveResponse,
     type InvocationUpdateResponse as InvocationUpdateResponse,
+    type InvocationFollowResponse as InvocationFollowResponse,
     type InvocationCreateParams as InvocationCreateParams,
     type InvocationUpdateParams as InvocationUpdateParams,
   };

package/src/resources/shared.ts

@@ -0,0 +1,69 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export interface ErrorDetail {
+  /**
+   * Lower-level error code providing more specific detail
+   */
+  code?: string;
+
+  /**
+   * Further detail about the error
+   */
+  message?: string;
+}
+
+/**
+ * An error event from the application.
+ */
+export interface ErrorEvent {
+  error: ErrorModel;
+
+  /**
+   * Event type identifier (always "error").
+   */
+  event: 'error';
+
+  /**
+   * Time the error occurred.
+   */
+  timestamp: string;
+}
+
+export interface ErrorModel {
+  /**
+   * Application-specific error code (machine-readable)
+   */
+  code: string;
+
+  /**
+   * Human-readable error description for debugging
+   */
+  message: string;
+
+  /**
+   * Additional error details (for multiple errors)
+   */
+  details?: Array<ErrorDetail>;
+
+  inner_error?: ErrorDetail;
+}
+
+/**
+ * A log entry from the application.
+ */
+export interface LogEvent {
+  /**
+   * Event type identifier (always "log").
+   */
+  event: 'log';
+
+  /**
+   * Log message text.
+   */
+  message: string;
+
+  /**
+   * Time the log entry was produced.
+   */
+  timestamp: string;
+}

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.5.0'; // x-release-please-version
+export const VERSION = '0.6.0'; // x-release-please-version