@arcadeai/arcadejs 0.1.2

package/src/resources/tools/tools.ts

@@ -0,0 +1,249 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as Core from '../../core';
+import * as ToolsAPI from './tools';
+import * as Shared from '../shared';
+import { ToolDefinitionsOffsetPage } from '../shared';
+import * as FormattedAPI from './formatted';
+import { type OffsetPageParams } from '../../pagination';
+
+export class Tools extends APIResource {
+  formatted: FormattedAPI.Formatted = new FormattedAPI.Formatted(this._client);
+
+  /**
+   * Returns a page of tools, optionally filtered by toolkit
+   */
+  list(
+    query?: ToolListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ToolDefinitionsOffsetPage, Shared.ToolDefinition>;
+  list(options?: Core.RequestOptions): Core.PagePromise<ToolDefinitionsOffsetPage, Shared.ToolDefinition>;
+  list(
+    query: ToolListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ToolDefinitionsOffsetPage, Shared.ToolDefinition> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.getAPIList('/v1/tools/list', ToolDefinitionsOffsetPage, { query, ...options });
+  }
+
+  /**
+   * Authorizes a user for a specific tool by name
+   */
+  authorize(
+    body: ToolAuthorizeParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Shared.AuthorizationResponse> {
+    return this._client.post('/v1/tools/authorize', { body, ...options });
+  }
+
+  /**
+   * Executes a tool by name and arguments
+   */
+  execute(body: ToolExecuteParams, options?: Core.RequestOptions): Core.APIPromise<Response> {
+    return this._client.post('/v1/tools/execute', { body, ...options });
+  }
+
+  /**
+   * Returns the arcade tool specification for a specific tool
+   */
+  get(query: ToolGetParams, options?: Core.RequestOptions): Core.APIPromise<Shared.ToolDefinition> {
+    return this._client.get('/v1/tools/definition', { query, ...options });
+  }
+}
+
+export interface AuthorizeToolRequest {
+  tool_name: string;
+
+  user_id: string;
+
+  /**
+   * Optional: if not provided, any version is used
+   */
+  tool_version?: string;
+}
+
+export interface ExecuteToolRequest {
+  tool_name: string;
+
+  /**
+   * JSON input to the tool, if any
+   */
+  inputs?: unknown;
+
+  /**
+   * Optional: if not provided, any version is used
+   */
+  tool_version?: string;
+
+  user_id?: string;
+}
+
+export interface Inputs {
+  parameters?: Array<Parameter>;
+}
+
+export interface Output {
+  available_modes?: Array<string>;
+
+  description?: string;
+
+  value_schema?: ValueSchema;
+}
+
+export interface Parameter {
+  name: string;
+
+  value_schema: ValueSchema;
+
+  description?: string;
+
+  inferrable?: boolean;
+
+  required?: boolean;
+}
+
+export interface Requirements {
+  authorization?: Requirements.Authorization;
+}
+
+export namespace Requirements {
+  export interface Authorization {
+    oauth2?: Authorization.Oauth2;
+
+    provider_id?: string;
+
+    provider_type?: string;
+  }
+
+  export namespace Authorization {
+    export interface Oauth2 {
+      scopes?: Array<string>;
+    }
+  }
+}
+
+export interface Response {
+  invocation_id: string;
+
+  duration?: number;
+
+  finished_at?: Response.FinishedAt;
+
+  output?: ResponseOutput;
+
+  success?: boolean;
+}
+
+export namespace Response {
+  export interface FinishedAt {
+    'time.Time'?: string;
+  }
+}
+
+export interface ResponseOutput {
+  error?: ResponseOutput.Error;
+
+  requires_authorization?: Shared.AuthorizationResponse;
+
+  value?: unknown;
+}
+
+export namespace ResponseOutput {
+  export interface Error {
+    message: string;
+
+    additional_prompt_content?: string;
+
+    can_retry?: boolean;
+
+    developer_message?: string;
+
+    retry_after_ms?: number;
+  }
+}
+
+export interface ToolkitDefinition {
+  name: string;
+
+  description?: string;
+
+  version?: string;
+}
+
+export interface ValueSchema {
+  val_type: string;
+
+  enum?: Array<string>;
+
+  inner_val_type?: string;
+}
+
+export interface ToolListParams extends OffsetPageParams {
+  /**
+   * Toolkit name
+   */
+  toolkit?: string;
+}
+
+export interface ToolAuthorizeParams {
+  tool_name: string;
+
+  user_id: string;
+
+  /**
+   * Optional: if not provided, any version is used
+   */
+  tool_version?: string;
+}
+
+export interface ToolExecuteParams {
+  tool_name: string;
+
+  /**
+   * JSON input to the tool, if any
+   */
+  inputs?: unknown;
+
+  /**
+   * Optional: if not provided, any version is used
+   */
+  tool_version?: string;
+
+  user_id?: string;
+}
+
+export interface ToolGetParams {
+  /**
+   * Tool ID
+   */
+  toolId: string;
+}
+
+export namespace Tools {
+  export import AuthorizeToolRequest = ToolsAPI.AuthorizeToolRequest;
+  export import ExecuteToolRequest = ToolsAPI.ExecuteToolRequest;
+  export import Inputs = ToolsAPI.Inputs;
+  export import Output = ToolsAPI.Output;
+  export import Parameter = ToolsAPI.Parameter;
+  export import Requirements = ToolsAPI.Requirements;
+  export import Response = ToolsAPI.Response;
+  export import ResponseOutput = ToolsAPI.ResponseOutput;
+  export import ToolkitDefinition = ToolsAPI.ToolkitDefinition;
+  export import ValueSchema = ToolsAPI.ValueSchema;
+  export import ToolListParams = ToolsAPI.ToolListParams;
+  export import ToolAuthorizeParams = ToolsAPI.ToolAuthorizeParams;
+  export import ToolExecuteParams = ToolsAPI.ToolExecuteParams;
+  export import ToolGetParams = ToolsAPI.ToolGetParams;
+  export import Formatted = FormattedAPI.Formatted;
+  export import FormattedListResponse = FormattedAPI.FormattedListResponse;
+  export import FormattedGetResponse = FormattedAPI.FormattedGetResponse;
+  export import FormattedListResponsesOffsetPage = FormattedAPI.FormattedListResponsesOffsetPage;
+  export import FormattedListParams = FormattedAPI.FormattedListParams;
+  export import FormattedGetParams = FormattedAPI.FormattedGetParams;
+}
+
+export { ToolDefinitionsOffsetPage };

package/src/resources/tools.ts

@@ -0,0 +1,240 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as ToolsAPI from './tools';
+import * as Shared from './shared';
+import { ToolDefinitionsOffsetPage } from './shared';
+import { type OffsetPageParams } from '../pagination';
+
+export class Tools extends APIResource {
+  /**
+   * Returns a list of tools, optionally filtered by toolkit or auth provider
+   */
+  list(
+    query?: ToolListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ToolDefinitionsOffsetPage, Shared.ToolDefinition>;
+  list(options?: Core.RequestOptions): Core.PagePromise<ToolDefinitionsOffsetPage, Shared.ToolDefinition>;
+  list(
+    query: ToolListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ToolDefinitionsOffsetPage, Shared.ToolDefinition> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.getAPIList('/v1/tools/list', ToolDefinitionsOffsetPage, { query, ...options });
+  }
+
+  /**
+   * Authorizes a user for a specific tool by name
+   */
+  authorize(
+    body: ToolAuthorizeParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Shared.AuthorizationResponse> {
+    return this._client.post('/v1/tools/authorize', { body, ...options });
+  }
+
+  /**
+   * Executes a tool by name and arguments
+   */
+  execute(body: ToolExecuteParams, options?: Core.RequestOptions): Core.APIPromise<Response> {
+    return this._client.post('/v1/tools/execute', { body, ...options });
+  }
+
+  /**
+   * Returns the arcade tool specification for a specific tool
+   */
+  get(query: ToolGetParams, options?: Core.RequestOptions): Core.APIPromise<Shared.ToolDefinition> {
+    return this._client.get('/v1/tools/definition', { query, ...options });
+  }
+}
+
+export interface AuthorizeToolRequest {
+  tool_name: string;
+
+  user_id: string;
+
+  /**
+   * Optional: if not provided, any version is used
+   */
+  tool_version?: string;
+}
+
+export interface ExecuteToolRequest {
+  tool_name: string;
+
+  /**
+   * Serialized JSON string
+   */
+  inputs?: string;
+
+  /**
+   * Optional: if not provided, any version is used
+   */
+  tool_version?: string;
+
+  user_id?: string;
+}
+
+export interface Inputs {
+  parameters?: Array<Parameter>;
+}
+
+export interface Output {
+  available_modes?: Array<string>;
+
+  description?: string;
+
+  value_schema?: ValueSchema;
+}
+
+export interface Parameter {
+  name: string;
+
+  value_schema: ValueSchema;
+
+  description?: string;
+
+  inferrable?: boolean;
+
+  required?: boolean;
+}
+
+export interface Requirements {
+  authorization?: Requirements.Authorization;
+}
+
+export namespace Requirements {
+  export interface Authorization {
+    oauth2?: Authorization.Oauth2;
+
+    provider_id?: string;
+
+    provider_type?: string;
+  }
+
+  export namespace Authorization {
+    export interface Oauth2 {
+      scopes?: Array<string>;
+    }
+  }
+}
+
+export interface Response {
+  invocation_id: string;
+
+  duration?: number;
+
+  finished_at?: Response.FinishedAt;
+
+  output?: ResponseOutput;
+
+  success?: boolean;
+}
+
+export namespace Response {
+  export interface FinishedAt {
+    'time.Time'?: string;
+  }
+}
+
+export interface ResponseOutput {
+  error?: ResponseOutput.Error;
+
+  requires_authorization?: Shared.AuthorizationResponse;
+
+  value?: unknown;
+}
+
+export namespace ResponseOutput {
+  export interface Error {
+    message: string;
+
+    additional_prompt_content?: string;
+
+    can_retry?: boolean;
+
+    developer_message?: string;
+
+    retry_after_ms?: number;
+  }
+}
+
+export interface ToolkitDefinition {
+  name: string;
+
+  description?: string;
+
+  version?: string;
+}
+
+export interface ValueSchema {
+  val_type: string;
+
+  enum?: Array<string>;
+
+  inner_val_type?: string;
+}
+
+export interface ToolListParams extends OffsetPageParams {
+  /**
+   * Toolkit name
+   */
+  toolkit?: string;
+}
+
+export interface ToolAuthorizeParams {
+  tool_name: string;
+
+  user_id: string;
+
+  /**
+   * Optional: if not provided, any version is used
+   */
+  tool_version?: string;
+}
+
+export interface ToolExecuteParams {
+  tool_name: string;
+
+  /**
+   * Serialized JSON string
+   */
+  inputs?: string;
+
+  /**
+   * Optional: if not provided, any version is used
+   */
+  tool_version?: string;
+
+  user_id?: string;
+}
+
+export interface ToolGetParams {
+  /**
+   * Tool ID
+   */
+  toolId: string;
+}
+
+export namespace Tools {
+  export import AuthorizeToolRequest = ToolsAPI.AuthorizeToolRequest;
+  export import ExecuteToolRequest = ToolsAPI.ExecuteToolRequest;
+  export import Inputs = ToolsAPI.Inputs;
+  export import Output = ToolsAPI.Output;
+  export import Parameter = ToolsAPI.Parameter;
+  export import Requirements = ToolsAPI.Requirements;
+  export import Response = ToolsAPI.Response;
+  export import ResponseOutput = ToolsAPI.ResponseOutput;
+  export import ToolkitDefinition = ToolsAPI.ToolkitDefinition;
+  export import ValueSchema = ToolsAPI.ValueSchema;
+  export import ToolListParams = ToolsAPI.ToolListParams;
+  export import ToolAuthorizeParams = ToolsAPI.ToolAuthorizeParams;
+  export import ToolExecuteParams = ToolsAPI.ToolExecuteParams;
+  export import ToolGetParams = ToolsAPI.ToolGetParams;
+}
+
+export { ToolDefinitionsOffsetPage };

package/src/shims/node.ts

@@ -0,0 +1,50 @@
+// @ts-ignore
+import * as types from '../_shims/node-types';
+import { setShims } from '../_shims/registry';
+import { getRuntime } from '../_shims/node-runtime';
+setShims(getRuntime());
+
+declare module '../_shims/manual-types' {
+  export namespace manual {
+    // @ts-ignore
+    export type Agent = types.Agent;
+    // @ts-ignore
+    export import fetch = types.fetch;
+    // @ts-ignore
+    export type Request = types.Request;
+    // @ts-ignore
+    export type RequestInfo = types.RequestInfo;
+    // @ts-ignore
+    export type RequestInit = types.RequestInit;
+    // @ts-ignore
+    export type Response = types.Response;
+    // @ts-ignore
+    export type ResponseInit = types.ResponseInit;
+    // @ts-ignore
+    export type ResponseType = types.ResponseType;
+    // @ts-ignore
+    export type BodyInit = types.BodyInit;
+    // @ts-ignore
+    export type Headers = types.Headers;
+    // @ts-ignore
+    export type HeadersInit = types.HeadersInit;
+    // @ts-ignore
+    export type BlobPropertyBag = types.BlobPropertyBag;
+    // @ts-ignore
+    export type FilePropertyBag = types.FilePropertyBag;
+    // @ts-ignore
+    export type FileFromPathOptions = types.FileFromPathOptions;
+    // @ts-ignore
+    export import FormData = types.FormData;
+    // @ts-ignore
+    export import File = types.File;
+    // @ts-ignore
+    export import Blob = types.Blob;
+    // @ts-ignore
+    export type Readable = types.Readable;
+    // @ts-ignore
+    export type FsReadStream = types.FsReadStream;
+    // @ts-ignore
+    export import ReadableStream = types.ReadableStream;
+  }
+}

package/src/shims/web.ts

@@ -0,0 +1,50 @@
+// @ts-ignore
+import * as types from '../_shims/web-types';
+import { setShims } from '../_shims/registry';
+import { getRuntime } from '../_shims/web-runtime';
+setShims(getRuntime({ manuallyImported: true }));
+
+declare module '../_shims/manual-types' {
+  export namespace manual {
+    // @ts-ignore
+    export type Agent = types.Agent;
+    // @ts-ignore
+    export import fetch = types.fetch;
+    // @ts-ignore
+    export type Request = types.Request;
+    // @ts-ignore
+    export type RequestInfo = types.RequestInfo;
+    // @ts-ignore
+    export type RequestInit = types.RequestInit;
+    // @ts-ignore
+    export type Response = types.Response;
+    // @ts-ignore
+    export type ResponseInit = types.ResponseInit;
+    // @ts-ignore
+    export type ResponseType = types.ResponseType;
+    // @ts-ignore
+    export type BodyInit = types.BodyInit;
+    // @ts-ignore
+    export type Headers = types.Headers;
+    // @ts-ignore
+    export type HeadersInit = types.HeadersInit;
+    // @ts-ignore
+    export type BlobPropertyBag = types.BlobPropertyBag;
+    // @ts-ignore
+    export type FilePropertyBag = types.FilePropertyBag;
+    // @ts-ignore
+    export type FileFromPathOptions = types.FileFromPathOptions;
+    // @ts-ignore
+    export import FormData = types.FormData;
+    // @ts-ignore
+    export import File = types.File;
+    // @ts-ignore
+    export import Blob = types.Blob;
+    // @ts-ignore
+    export type Readable = types.Readable;
+    // @ts-ignore
+    export type FsReadStream = types.FsReadStream;
+    // @ts-ignore
+    export import ReadableStream = types.ReadableStream;
+  }
+}

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "es2015",
+    "lib": ["DOM"],
+    "moduleResolution": "node"
+  }
+}