@arcadeai/arcadejs 0.1.2

package/src/error.ts

@@ -0,0 +1,146 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { castToError, Headers } from './core';
+
+export class ArcadeError extends Error {}
+
+export class APIError extends ArcadeError {
+  readonly status: number | undefined;
+  readonly headers: Headers | undefined;
+  readonly error: Object | undefined;
+
+  constructor(
+    status: number | undefined,
+    error: Object | undefined,
+    message: string | undefined,
+    headers: Headers | undefined,
+  ) {
+    super(`${APIError.makeMessage(status, error, message)}`);
+    this.status = status;
+    this.headers = headers;
+    this.error = error;
+  }
+
+  private static makeMessage(status: number | undefined, error: any, message: string | undefined) {
+    const msg =
+      error?.message ?
+        typeof error.message === 'string' ?
+          error.message
+        : JSON.stringify(error.message)
+      : error ? JSON.stringify(error)
+      : message;
+
+    if (status && msg) {
+      return `${status} ${msg}`;
+    }
+    if (status) {
+      return `${status} status code (no body)`;
+    }
+    if (msg) {
+      return msg;
+    }
+    return '(no status code or body)';
+  }
+
+  static generate(
+    status: number | undefined,
+    errorResponse: Object | undefined,
+    message: string | undefined,
+    headers: Headers | undefined,
+  ) {
+    if (!status) {
+      return new APIConnectionError({ message, cause: castToError(errorResponse) });
+    }
+
+    const error = errorResponse as Record<string, any>;
+
+    if (status === 400) {
+      return new BadRequestError(status, error, message, headers);
+    }
+
+    if (status === 401) {
+      return new AuthenticationError(status, error, message, headers);
+    }
+
+    if (status === 403) {
+      return new PermissionDeniedError(status, error, message, headers);
+    }
+
+    if (status === 404) {
+      return new NotFoundError(status, error, message, headers);
+    }
+
+    if (status === 409) {
+      return new ConflictError(status, error, message, headers);
+    }
+
+    if (status === 422) {
+      return new UnprocessableEntityError(status, error, message, headers);
+    }
+
+    if (status === 429) {
+      return new RateLimitError(status, error, message, headers);
+    }
+
+    if (status >= 500) {
+      return new InternalServerError(status, error, message, headers);
+    }
+
+    return new APIError(status, error, message, headers);
+  }
+}
+
+export class APIUserAbortError extends APIError {
+  override readonly status: undefined = undefined;
+
+  constructor({ message }: { message?: string } = {}) {
+    super(undefined, undefined, message || 'Request was aborted.', undefined);
+  }
+}
+
+export class APIConnectionError extends APIError {
+  override readonly status: undefined = undefined;
+
+  constructor({ message, cause }: { message?: string | undefined; cause?: Error | undefined }) {
+    super(undefined, undefined, message || 'Connection error.', undefined);
+    // in some environments the 'cause' property is already declared
+    // @ts-ignore
+    if (cause) this.cause = cause;
+  }
+}
+
+export class APIConnectionTimeoutError extends APIConnectionError {
+  constructor({ message }: { message?: string } = {}) {
+    super({ message: message ?? 'Request timed out.' });
+  }
+}
+
+export class BadRequestError extends APIError {
+  override readonly status: 400 = 400;
+}
+
+export class AuthenticationError extends APIError {
+  override readonly status: 401 = 401;
+}
+
+export class PermissionDeniedError extends APIError {
+  override readonly status: 403 = 403;
+}
+
+export class NotFoundError extends APIError {
+  override readonly status: 404 = 404;
+}
+
+export class ConflictError extends APIError {
+  override readonly status: 409 = 409;
+}
+
+export class UnprocessableEntityError extends APIError {
+  override readonly status: 422 = 422;
+}
+
+export class RateLimitError extends APIError {
+  override readonly status: 429 = 429;
+}
+
+export class InternalServerError extends APIError {}

package/src/index.ts

@@ -0,0 +1,227 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Errors from './error';
+import * as Uploads from './uploads';
+import { type Agent } from './_shims/index';
+import * as Core from './core';
+import * as Pagination from './pagination';
+import * as API from './resources/index';
+
+export interface ClientOptions {
+  /**
+   * API key used for authorization in header
+   */
+  apiKey?: string | undefined;
+
+  /**
+   * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
+   *
+   * Defaults to process.env['ARCADE_BASE_URL'].
+   */
+  baseURL?: string | null | undefined;
+
+  /**
+   * The maximum amount of time (in milliseconds) that the client should wait for a response
+   * from the server before timing out a single request.
+   *
+   * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
+   * much longer than this timeout before the promise succeeds or fails.
+   */
+  timeout?: number;
+
+  /**
+   * An HTTP agent used to manage HTTP(S) connections.
+   *
+   * If not provided, an agent will be constructed by default in the Node.js environment,
+   * otherwise no agent is used.
+   */
+  httpAgent?: Agent;
+
+  /**
+   * Specify a custom `fetch` function implementation.
+   *
+   * If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is
+   * defined globally.
+   */
+  fetch?: Core.Fetch | undefined;
+
+  /**
+   * The maximum number of times that the client will retry a request in case of a
+   * temporary failure, like a network error or a 5XX error from the server.
+   *
+   * @default 2
+   */
+  maxRetries?: number;
+
+  /**
+   * Default headers to include with every request to the API.
+   *
+   * These can be removed in individual requests by explicitly setting the
+   * header to `undefined` or `null` in request options.
+   */
+  defaultHeaders?: Core.Headers;
+
+  /**
+   * Default query parameters to include with every request to the API.
+   *
+   * These can be removed in individual requests by explicitly setting the
+   * param to `undefined` in request options.
+   */
+  defaultQuery?: Core.DefaultQuery;
+}
+
+/**
+ * API Client for interfacing with the Arcade API.
+ */
+export class Arcade extends Core.APIClient {
+  apiKey: string;
+
+  private _options: ClientOptions;
+
+  /**
+   * API Client for interfacing with the Arcade API.
+   *
+   * @param {string | undefined} [opts.apiKey=process.env['ARCADE_API_KEY'] ?? undefined]
+   * @param {string} [opts.baseURL=process.env['ARCADE_BASE_URL'] ?? https://api.arcade-ai.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 {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
+   * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
+   * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
+   * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
+   * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
+   */
+  constructor({
+    baseURL = Core.readEnv('ARCADE_BASE_URL'),
+    apiKey = Core.readEnv('ARCADE_API_KEY'),
+    ...opts
+  }: ClientOptions = {}) {
+    if (apiKey === undefined) {
+      throw new Errors.ArcadeError(
+        "The ARCADE_API_KEY environment variable is missing or empty; either provide it, or instantiate the Arcade client with an apiKey option, like new Arcade({ apiKey: 'My API Key' }).",
+      );
+    }
+
+    const options: ClientOptions = {
+      apiKey,
+      ...opts,
+      baseURL: baseURL || `https://api.arcade-ai.com`,
+    };
+
+    super({
+      baseURL: options.baseURL!,
+      timeout: options.timeout ?? 60000 /* 1 minute */,
+      httpAgent: options.httpAgent,
+      maxRetries: options.maxRetries,
+      fetch: options.fetch,
+    });
+
+    this._options = options;
+    this.idempotencyHeader = 'Idempotency-Key';
+
+    this.apiKey = apiKey;
+  }
+
+  auth: API.Auth = new API.Auth(this);
+  health: API.Health = new API.Health(this);
+  chat: API.Chat = new API.Chat(this);
+  tools: API.Tools = new API.Tools(this);
+
+  protected override defaultQuery(): Core.DefaultQuery | undefined {
+    return this._options.defaultQuery;
+  }
+
+  protected override defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers {
+    return {
+      ...super.defaultHeaders(opts),
+      ...this._options.defaultHeaders,
+    };
+  }
+
+  protected override authHeaders(opts: Core.FinalRequestOptions): Core.Headers {
+    return { Authorization: this.apiKey };
+  }
+
+  static Arcade = this;
+  static DEFAULT_TIMEOUT = 60000; // 1 minute
+
+  static ArcadeError = Errors.ArcadeError;
+  static APIError = Errors.APIError;
+  static APIConnectionError = Errors.APIConnectionError;
+  static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
+  static APIUserAbortError = Errors.APIUserAbortError;
+  static NotFoundError = Errors.NotFoundError;
+  static ConflictError = Errors.ConflictError;
+  static RateLimitError = Errors.RateLimitError;
+  static BadRequestError = Errors.BadRequestError;
+  static AuthenticationError = Errors.AuthenticationError;
+  static InternalServerError = Errors.InternalServerError;
+  static PermissionDeniedError = Errors.PermissionDeniedError;
+  static UnprocessableEntityError = Errors.UnprocessableEntityError;
+
+  static toFile = Uploads.toFile;
+  static fileFromPath = Uploads.fileFromPath;
+}
+
+export const {
+  ArcadeError,
+  APIError,
+  APIConnectionError,
+  APIConnectionTimeoutError,
+  APIUserAbortError,
+  NotFoundError,
+  ConflictError,
+  RateLimitError,
+  BadRequestError,
+  AuthenticationError,
+  InternalServerError,
+  PermissionDeniedError,
+  UnprocessableEntityError,
+} = Errors;
+
+export import toFile = Uploads.toFile;
+export import fileFromPath = Uploads.fileFromPath;
+
+export namespace Arcade {
+  export import RequestOptions = Core.RequestOptions;
+
+  export import OffsetPage = Pagination.OffsetPage;
+  export import OffsetPageParams = Pagination.OffsetPageParams;
+  export import OffsetPageResponse = Pagination.OffsetPageResponse;
+
+  export import Auth = API.Auth;
+  export import AuthRequest = API.AuthRequest;
+  export import AuthAuthorizeParams = API.AuthAuthorizeParams;
+  export import AuthStatusParams = API.AuthStatusParams;
+
+  export import Health = API.Health;
+  export import HealthSchema = API.HealthSchema;
+
+  export import Chat = API.Chat;
+  export import ChatMessage = API.ChatMessage;
+  export import ChatRequest = API.ChatRequest;
+  export import ChatResponse = API.ChatResponse;
+  export import Choice = API.Choice;
+  export import Usage = API.Usage;
+
+  export import Tools = API.Tools;
+  export import AuthorizeToolRequest = API.AuthorizeToolRequest;
+  export import ExecuteToolRequest = API.ExecuteToolRequest;
+  export import Inputs = API.Inputs;
+  export import Output = API.Output;
+  export import Parameter = API.Parameter;
+  export import Requirements = API.Requirements;
+  export import Response = API.Response;
+  export import ResponseOutput = API.ResponseOutput;
+  export import ToolkitDefinition = API.ToolkitDefinition;
+  export import ValueSchema = API.ValueSchema;
+  export import ToolListParams = API.ToolListParams;
+  export import ToolAuthorizeParams = API.ToolAuthorizeParams;
+  export import ToolExecuteParams = API.ToolExecuteParams;
+  export import ToolGetParams = API.ToolGetParams;
+
+  export import AuthorizationResponse = API.AuthorizationResponse;
+  export import Error = API.Error;
+  export import ToolDefinition = API.ToolDefinition;
+}
+
+export default Arcade;

package/src/lib/.keep

@@ -0,0 +1,4 @@
+File generated from our OpenAPI spec by Stainless.
+
+This directory can be used to store custom files to expand the SDK.
+It is ignored by Stainless code generation and its content (other than this keep file) won't be touched.

package/src/pagination.ts

@@ -0,0 +1,79 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { AbstractPage, Response, APIClient, FinalRequestOptions, PageInfo } from './core';
+
+export interface OffsetPageResponse<Item> {
+  items: Array<Item>;
+
+  total_count: number;
+
+  offset: number;
+}
+
+export interface OffsetPageParams {
+  /**
+   * The number of elements to skip.
+   */
+  offset?: number;
+
+  /**
+   * The maximum number of elements to fetch.
+   */
+  limit?: number;
+}
+
+export class OffsetPage<Item> extends AbstractPage<Item> implements OffsetPageResponse<Item> {
+  items: Array<Item>;
+
+  total_count: number;
+
+  offset: number;
+
+  constructor(
+    client: APIClient,
+    response: Response,
+    body: OffsetPageResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.items = body.items || [];
+    this.total_count = body.total_count || 0;
+    this.offset = body.offset || 0;
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.items ?? [];
+  }
+
+  // @deprecated Please use `nextPageInfo()` instead
+  nextPageParams(): Partial<OffsetPageParams> | null {
+    const info = this.nextPageInfo();
+    if (!info) return null;
+    if ('params' in info) return info.params;
+    const params = Object.fromEntries(info.url.searchParams);
+    if (!Object.keys(params).length) return null;
+    return params;
+  }
+
+  nextPageInfo(): PageInfo | null {
+    const offset = this.offset;
+    if (!offset) {
+      return null;
+    }
+
+    const length = this.getPaginatedItems().length;
+    const currentCount = offset + length;
+
+    const totalCount = this.total_count;
+    if (!totalCount) {
+      return null;
+    }
+
+    if (currentCount < totalCount) {
+      return { params: { offset: currentCount } };
+    }
+
+    return null;
+  }
+}

package/src/resource.ts

@@ -0,0 +1,11 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import type { Arcade } from './index';
+
+export class APIResource {
+  protected _client: Arcade;
+
+  constructor(client: Arcade) {
+    this._client = client;
+  }
+}

package/src/resources/auth.ts

@@ -0,0 +1,97 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import * as Core from '../core';
+import * as AuthAPI from './auth';
+import * as Shared from './shared';
+
+export class Auth extends APIResource {
+  /**
+   * Starts the authorization process for given authorization requirements
+   */
+  authorize(
+    body: AuthAuthorizeParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Shared.AuthorizationResponse> {
+    return this._client.post('/v1/auth/authorize', { body, ...options });
+  }
+
+  /**
+   * Checks the status of an ongoing authorization process for a specific tool. If
+   * 'wait' param is present, does not respond until either the auth status becomes
+   * completed or the timeout is reached.
+   */
+  status(
+    query: AuthStatusParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Shared.AuthorizationResponse> {
+    return this._client.get('/v1/auth/status', { query, ...options });
+  }
+}
+
+export interface AuthRequest {
+  auth_requirement: AuthRequest.AuthRequirement;
+
+  user_id: string;
+}
+
+export namespace AuthRequest {
+  export interface AuthRequirement {
+    oauth2?: AuthRequirement.Oauth2;
+
+    provider_id?: string;
+
+    provider_type?: string;
+  }
+
+  export namespace AuthRequirement {
+    export interface Oauth2 {
+      scopes?: Array<string>;
+    }
+  }
+}
+
+export interface AuthAuthorizeParams {
+  auth_requirement: AuthAuthorizeParams.AuthRequirement;
+
+  user_id: string;
+}
+
+export namespace AuthAuthorizeParams {
+  export interface AuthRequirement {
+    oauth2?: AuthRequirement.Oauth2;
+
+    provider_id?: string;
+
+    provider_type?: string;
+  }
+
+  export namespace AuthRequirement {
+    export interface Oauth2 {
+      scopes?: Array<string>;
+    }
+  }
+}
+
+export interface AuthStatusParams {
+  /**
+   * Authorization ID
+   */
+  authorizationId: string;
+
+  /**
+   * Scopes
+   */
+  scopes?: string;
+
+  /**
+   * Timeout in seconds (max 59)
+   */
+  wait?: number;
+}
+
+export namespace Auth {
+  export import AuthRequest = AuthAPI.AuthRequest;
+  export import AuthAuthorizeParams = AuthAPI.AuthAuthorizeParams;
+  export import AuthStatusParams = AuthAPI.AuthStatusParams;
+}