feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 11
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/droidrun%2Fdroidrun-cloud-c2003f937f2d33680b6815e4330d17a11e8ce766c2b9c0f2071b4e34ed6c78fc.yml
-openapi_spec_hash: 7801da9a4589d1fd4811f9d86b3e39c2
-config_hash: b31c431785f82620b575ae9eca23ffea
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/droidrun%2Fdroidrun-cloud-4f4b587e30045f155d30d02200881dbb7c17d5fc5c9b3b7627b817c12c451f63.yml
+openapi_spec_hash: bab2879c01d364918e0a136dd286def8
+config_hash: 21ecaf3401577ecdb4496cff7e07cb43

README.md

@@ -27,9 +27,7 @@ import DroidrunCloud from 'droidrun-cloud';
 
 const client = new DroidrunCloud();
 
-const response = await client.tasks.run({ task: 'x' });
-
-console.log(response.id);
+const response = await client.tasks.run({ body: {} });
 ```
 
 ### Request & Response types
@@ -42,8 +40,8 @@ import DroidrunCloud from 'droidrun-cloud';
 
 const client = new DroidrunCloud();
 
-const params: DroidrunCloud.TaskRunParams = { task: 'x' };
-const response: DroidrunCloud.TaskRunResponse = await client.tasks.run(params);
+const params: DroidrunCloud.TaskRunParams = { body: {} };
+const response: unknown = await client.tasks.run(params);
 ```
 
 Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
@@ -56,7 +54,7 @@ a subclass of `APIError` will be thrown:
 
 <!-- prettier-ignore -->
 ```ts
-const response = await client.tasks.run({ task: 'x' }).catch(async (err) => {
+const response = await client.tasks.run({ body: {} }).catch(async (err) => {
   if (err instanceof DroidrunCloud.APIError) {
     console.log(err.status); // 400
     console.log(err.name); // BadRequestError
@@ -93,11 +91,12 @@ You can use the `maxRetries` option to configure or disable this:
 // Configure the default for all requests:
 const client = new DroidrunCloud({
   apiKey: 'My API Key',
+  bearer: 'My Bearer',
   maxRetries: 0, // default is 2
 });
 
 // Or, configure per-request:
-await client.tasks.run({ task: 'x' }, {
+await client.tasks.run({ body: {} }, {
   maxRetries: 5,
 });
 ```
@@ -111,11 +110,12 @@ Requests time out after 1 minute by default. You can configure this with a `time
 // Configure the default for all requests:
 const client = new DroidrunCloud({
   apiKey: 'My API Key',
+  bearer: 'My Bearer',
   timeout: 20 * 1000, // 20 seconds (default is 1 minute)
 });
 
 // Override per-request:
-await client.tasks.run({ task: 'x' }, {
+await client.tasks.run({ body: {} }, {
   timeout: 5 * 1000,
 });
 ```
@@ -138,13 +138,13 @@ Unlike `.asResponse()` this method consumes the body, returning once it is parse
 ```ts
 const client = new DroidrunCloud();
 
-const response = await client.tasks.run({ task: 'x' }).asResponse();
+const response = await client.tasks.run({ body: {} }).asResponse();
 console.log(response.headers.get('X-My-Header'));
 console.log(response.statusText); // access the underlying Response object
 
-const { data: response, response: raw } = await client.tasks.run({ task: 'x' }).withResponse();
+const { data: response, response: raw } = await client.tasks.run({ body: {} }).withResponse();
 console.log(raw.headers.get('X-My-Header'));
-console.log(response.id);
+console.log(response);
 ```
 
 ### Logging

api.md

@@ -2,37 +2,34 @@
 
 Types:
 
-- <code><a href="./src/resources/tasks/tasks.ts">LlmModel</a></code>
-- <code><a href="./src/resources/tasks/tasks.ts">Task</a></code>
-- <code><a href="./src/resources/tasks/tasks.ts">TaskCreate</a></code>
-- <code><a href="./src/resources/tasks/tasks.ts">TaskStatus</a></code>
 - <code><a href="./src/resources/tasks/tasks.ts">TaskRetrieveResponse</a></code>
 - <code><a href="./src/resources/tasks/tasks.ts">TaskListResponse</a></code>
+- <code><a href="./src/resources/tasks/tasks.ts">TaskGetGifResponse</a></code>
 - <code><a href="./src/resources/tasks/tasks.ts">TaskGetStatusResponse</a></code>
 - <code><a href="./src/resources/tasks/tasks.ts">TaskGetTrajectoryResponse</a></code>
 - <code><a href="./src/resources/tasks/tasks.ts">TaskRunResponse</a></code>
 - <code><a href="./src/resources/tasks/tasks.ts">TaskStopResponse</a></code>
 
 Methods:
 
-- <code title="get /tasks/{task_id}">client.tasks.<a href="./src/resources/tasks/tasks.ts">retrieve</a>(taskID) -> TaskRetrieveResponse</code>
-- <code title="get /tasks/">client.tasks.<a href="./src/resources/tasks/tasks.ts">list</a>({ ...params }) -> TaskListResponse</code>
+- <code title="get /tasks/{task_id}">client.tasks.<a href="./src/resources/tasks/tasks.ts">retrieve</a>(taskID) -> unknown</code>
+- <code title="get /tasks/">client.tasks.<a href="./src/resources/tasks/tasks.ts">list</a>({ ...params }) -> unknown</code>
 - <code title="get /tasks/{task_id}/attach">client.tasks.<a href="./src/resources/tasks/tasks.ts">attach</a>(taskID) -> void</code>
-- <code title="get /tasks/{task_id}/gif">client.tasks.<a href="./src/resources/tasks/tasks.ts">getGif</a>(taskID) -> MediaResponse</code>
-- <code title="get /tasks/{task_id}/status">client.tasks.<a href="./src/resources/tasks/tasks.ts">getStatus</a>(taskID) -> TaskGetStatusResponse</code>
-- <code title="get /tasks/{task_id}/trajectory">client.tasks.<a href="./src/resources/tasks/tasks.ts">getTrajectory</a>(taskID) -> TaskGetTrajectoryResponse</code>
-- <code title="post /tasks/">client.tasks.<a href="./src/resources/tasks/tasks.ts">run</a>({ ...params }) -> TaskRunResponse</code>
+- <code title="get /tasks/{task_id}/gif">client.tasks.<a href="./src/resources/tasks/tasks.ts">getGif</a>(taskID) -> unknown</code>
+- <code title="get /tasks/{task_id}/status">client.tasks.<a href="./src/resources/tasks/tasks.ts">getStatus</a>(taskID) -> unknown</code>
+- <code title="get /tasks/{task_id}/trajectory">client.tasks.<a href="./src/resources/tasks/tasks.ts">getTrajectory</a>(taskID) -> unknown</code>
+- <code title="post /tasks/">client.tasks.<a href="./src/resources/tasks/tasks.ts">run</a>({ ...params }) -> unknown</code>
 - <code title="post /tasks/stream">client.tasks.<a href="./src/resources/tasks/tasks.ts">runStreamed</a>({ ...params }) -> void</code>
-- <code title="post /tasks/{task_id}/cancel">client.tasks.<a href="./src/resources/tasks/tasks.ts">stop</a>(taskID) -> TaskStopResponse</code>
+- <code title="post /tasks/{task_id}/cancel">client.tasks.<a href="./src/resources/tasks/tasks.ts">stop</a>(taskID) -> unknown</code>
 
 ## Screenshots
 
 Types:
 
-- <code><a href="./src/resources/tasks/screenshots.ts">MediaResponse</a></code>
+- <code><a href="./src/resources/tasks/screenshots.ts">ScreenshotRetrieveResponse</a></code>
 - <code><a href="./src/resources/tasks/screenshots.ts">ScreenshotListResponse</a></code>
 
 Methods:
 
-- <code title="get /tasks/{task_id}/screenshots/{index}">client.tasks.screenshots.<a href="./src/resources/tasks/screenshots.ts">retrieve</a>(index, { ...params }) -> MediaResponse</code>
-- <code title="get /tasks/{task_id}/screenshots">client.tasks.screenshots.<a href="./src/resources/tasks/screenshots.ts">list</a>(taskID) -> ScreenshotListResponse</code>
+- <code title="get /tasks/{task_id}/screenshots/{index}">client.tasks.screenshots.<a href="./src/resources/tasks/screenshots.ts">retrieve</a>(index, { ...params }) -> unknown</code>
+- <code title="get /tasks/{task_id}/screenshots">client.tasks.screenshots.<a href="./src/resources/tasks/screenshots.ts">list</a>(taskID) -> unknown</code>

src/client.ts

@@ -11,15 +11,14 @@ import type { APIResponseProps } from './internal/parse';
 import { getPlatformHeaders } from './internal/detect-platform';
 import * as Shims from './internal/shims';
 import * as Opts from './internal/request-options';
+import * as qs from './internal/qs';
 import { VERSION } from './version';
 import * as Errors from './core/error';
 import * as Uploads from './core/uploads';
 import * as API from './resources/index';
 import { APIPromise } from './core/api-promise';
 import {
-  LlmModel,
-  Task,
-  TaskCreate,
+  TaskGetGifResponse,
   TaskGetStatusResponse,
   TaskGetTrajectoryResponse,
   TaskListParams,
@@ -28,7 +27,6 @@ import {
   TaskRunParams,
   TaskRunResponse,
   TaskRunStreamedParams,
-  TaskStatus,
   TaskStopResponse,
   Tasks,
 } from './resources/tasks/tasks';
@@ -51,6 +49,11 @@ export interface ClientOptions {
    */
   apiKey?: string | undefined;
 
+  /**
+   * Defaults to process.env['DROIDRUN_CLOUD_BEARER_TOKEN'].
+   */
+  bearer?: string | undefined;
+
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
    *
@@ -125,6 +128,7 @@ export interface ClientOptions {
  */
 export class DroidrunCloud {
   apiKey: string;
+  bearer: string;
 
   baseURL: string;
   maxRetries: number;
@@ -142,6 +146,7 @@ export class DroidrunCloud {
    * API Client for interfacing with the Droidrun Cloud API.
    *
    * @param {string | undefined} [opts.apiKey=process.env['DROIDRUN_CLOUD_API_KEY'] ?? undefined]
+   * @param {string | undefined} [opts.bearer=process.env['DROIDRUN_CLOUD_BEARER_TOKEN'] ?? undefined]
    * @param {string} [opts.baseURL=process.env['DROIDRUN_CLOUD_BASE_URL'] ?? https://api.droidrun.ai/v1] - 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.
@@ -153,16 +158,23 @@ export class DroidrunCloud {
   constructor({
     baseURL = readEnv('DROIDRUN_CLOUD_BASE_URL'),
     apiKey = readEnv('DROIDRUN_CLOUD_API_KEY'),
+    bearer = readEnv('DROIDRUN_CLOUD_BEARER_TOKEN'),
     ...opts
   }: ClientOptions = {}) {
     if (apiKey === undefined) {
       throw new Errors.DroidrunCloudError(
         "The DROIDRUN_CLOUD_API_KEY environment variable is missing or empty; either provide it, or instantiate the DroidrunCloud client with an apiKey option, like new DroidrunCloud({ apiKey: 'My API Key' }).",
       );
     }
+    if (bearer === undefined) {
+      throw new Errors.DroidrunCloudError(
+        "The DROIDRUN_CLOUD_BEARER_TOKEN environment variable is missing or empty; either provide it, or instantiate the DroidrunCloud client with an bearer option, like new DroidrunCloud({ bearer: 'My Bearer' }).",
+      );
+    }
 
     const options: ClientOptions = {
       apiKey,
+      bearer,
       ...opts,
       baseURL: baseURL || `https://api.droidrun.ai/v1`,
     };
@@ -185,6 +197,7 @@ export class DroidrunCloud {
     this._options = options;
 
     this.apiKey = apiKey;
+    this.bearer = bearer;
   }
 
   /**
@@ -201,6 +214,7 @@ export class DroidrunCloud {
       fetch: this.fetch,
       fetchOptions: this.fetchOptions,
       apiKey: this.apiKey,
+      bearer: this.bearer,
       ...options,
     });
     return client;
@@ -221,24 +235,8 @@ export class DroidrunCloud {
     return;
   }
 
-  /**
-   * Basic re-implementation of `qs.stringify` for primitive types.
-   */
   protected stringifyQuery(query: Record<string, unknown>): string {
-    return Object.entries(query)
-      .filter(([_, value]) => typeof value !== 'undefined')
-      .map(([key, value]) => {
-        if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-          return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
-        }
-        if (value === null) {
-          return `${encodeURIComponent(key)}=`;
-        }
-        throw new Errors.DroidrunCloudError(
-          `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
-        );
-      })
-      .join('&');
+    return qs.stringify(query, { arrayFormat: 'comma' });
   }
 
   private getUserAgent(): string {
@@ -734,12 +732,9 @@ export declare namespace DroidrunCloud {
 
   export {
     Tasks as Tasks,
-    type LlmModel as LlmModel,
-    type Task as Task,
-    type TaskCreate as TaskCreate,
-    type TaskStatus as TaskStatus,
     type TaskRetrieveResponse as TaskRetrieveResponse,
     type TaskListResponse as TaskListResponse,
+    type TaskGetGifResponse as TaskGetGifResponse,
     type TaskGetStatusResponse as TaskGetStatusResponse,
     type TaskGetTrajectoryResponse as TaskGetTrajectoryResponse,
     type TaskRunResponse as TaskRunResponse,

src/internal/qs/LICENSE.md

@@ -0,0 +1,13 @@
+BSD 3-Clause License
+
+Copyright (c) 2014, Nathan LaFreniere and other [contributors](https://github.com/puruvj/neoqs/graphs/contributors) All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

src/internal/qs/README.md

@@ -0,0 +1,3 @@
+# qs
+
+This is a vendored version of [neoqs](https://github.com/PuruVJ/neoqs) which is a TypeScript rewrite of [qs](https://github.com/ljharb/qs), a query string library.

src/internal/qs/formats.ts

@@ -0,0 +1,10 @@
+import type { Format } from './types';
+
+export const default_format: Format = 'RFC3986';
+export const default_formatter = (v: PropertyKey) => String(v);
+export const formatters: Record<Format, (str: PropertyKey) => string> = {
+  RFC1738: (v: PropertyKey) => String(v).replace(/%20/g, '+'),
+  RFC3986: default_formatter,
+};
+export const RFC1738 = 'RFC1738';
+export const RFC3986 = 'RFC3986';

src/internal/qs/index.ts

@@ -0,0 +1,13 @@
+import { default_format, formatters, RFC1738, RFC3986 } from './formats';
+
+const formats = {
+  formatters,
+  RFC1738,
+  RFC3986,
+  default: default_format,
+};
+
+export { stringify } from './stringify';
+export { formats };
+
+export type { DefaultDecoder, DefaultEncoder, Format, ParseOptions, StringifyOptions } from './types';