Merge pull request #62 from ArcadeAI/release-please--branches--main--changes--next--components--arcadejs

release: 1.0.0

Author: nbarbettini

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.2.2"
+  ".": "1.0.0"
 }

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 12
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/arcade-ai%2Farcade-engine-ccf89dc56f0b7fa4fef0fc4bb486fe3f2563a93a457cb38b3cf5cffb86649ddb.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/arcade-ai%2Farcade-engine-b51c646e673aa07b32ac0ee1c8eebe4be70e67681ad9eccb9d7a651bc42a6e04.yml

CHANGELOG.md

@@ -1,5 +1,44 @@
 # Changelog
 
+## 1.0.0 (2025-01-24)
+
+Full Changelog: [v0.2.2...v1.0.0](https://github.com/ArcadeAI/arcade-js/compare/v0.2.2...v1.0.0)
+
+### Features
+
+* **api:** api update ([#75](https://github.com/ArcadeAI/arcade-js/issues/75)) ([36eb88d](https://github.com/ArcadeAI/arcade-js/commit/36eb88ddefc2abfb9d8f550efa20cdacdaf8f283))
+* **api:** api update ([#76](https://github.com/ArcadeAI/arcade-js/issues/76)) ([2f699c1](https://github.com/ArcadeAI/arcade-js/commit/2f699c1ea33aac5bd168a9bafd8924f0185de3d3))
+* **api:** api update ([#78](https://github.com/ArcadeAI/arcade-js/issues/78)) ([1fae253](https://github.com/ArcadeAI/arcade-js/commit/1fae253828f24462b3b327d03b71df0ef157efc5))
+* **api:** api update ([#79](https://github.com/ArcadeAI/arcade-js/issues/79)) ([168b1f5](https://github.com/ArcadeAI/arcade-js/commit/168b1f550f966e6dd6d9d0870f1df32bb4d0eb9a))
+* **api:** api update ([#83](https://github.com/ArcadeAI/arcade-js/issues/83)) ([8b701be](https://github.com/ArcadeAI/arcade-js/commit/8b701be8dc3a2ff9e623b83a601e0c3beb35889e))
+* **api:** api update ([#84](https://github.com/ArcadeAI/arcade-js/issues/84)) ([801c58d](https://github.com/ArcadeAI/arcade-js/commit/801c58da6b947ecd5995740d8bf8afb74c527dd9))
+
+
+### Bug Fixes
+
+* **client:** normalize method ([#61](https://github.com/ArcadeAI/arcade-js/issues/61)) ([7f729f2](https://github.com/ArcadeAI/arcade-js/commit/7f729f27460aa59a4cc3b19c893062fcc4ca7198))
+* **client:** normalize method ([#70](https://github.com/ArcadeAI/arcade-js/issues/70)) ([346cc8a](https://github.com/ArcadeAI/arcade-js/commit/346cc8a5054e6120c1d8e320c98e72e9cd07ccb6))
+
+
+### Chores
+
+* **internal:** codegen related update ([#63](https://github.com/ArcadeAI/arcade-js/issues/63)) ([0b6a70b](https://github.com/ArcadeAI/arcade-js/commit/0b6a70b4882c5b70ee0f1ee4cff5621263576e11))
+* **internal:** codegen related update ([#64](https://github.com/ArcadeAI/arcade-js/issues/64)) ([4e9b37b](https://github.com/ArcadeAI/arcade-js/commit/4e9b37bb9615b1ee869c4d7116978be04bf27650))
+* **internal:** codegen related update ([#65](https://github.com/ArcadeAI/arcade-js/issues/65)) ([ec268d8](https://github.com/ArcadeAI/arcade-js/commit/ec268d8b98c6a2dbf35a5ffc4006abbec2850fce))
+* **internal:** codegen related update ([#66](https://github.com/ArcadeAI/arcade-js/issues/66)) ([e2944f0](https://github.com/ArcadeAI/arcade-js/commit/e2944f04cff49300381faa8a06a53fd9be23a83d))
+* **internal:** codegen related update ([#67](https://github.com/ArcadeAI/arcade-js/issues/67)) ([0f7971e](https://github.com/ArcadeAI/arcade-js/commit/0f7971eff276dc2b564db624340908036fba9892))
+* **internal:** codegen related update ([#68](https://github.com/ArcadeAI/arcade-js/issues/68)) ([82e6e41](https://github.com/ArcadeAI/arcade-js/commit/82e6e41b778470ce34953905c6c6b669a4ba423e))
+* **internal:** codegen related update ([#69](https://github.com/ArcadeAI/arcade-js/issues/69)) ([1315d00](https://github.com/ArcadeAI/arcade-js/commit/1315d00b4573c6ba6fada3cf71df1d32b11b2ce2))
+* **internal:** codegen related update ([#72](https://github.com/ArcadeAI/arcade-js/issues/72)) ([46e5837](https://github.com/ArcadeAI/arcade-js/commit/46e58375269048cf1a58445b0fe1e266d3416402))
+* **internal:** codegen related update ([#74](https://github.com/ArcadeAI/arcade-js/issues/74)) ([fc4035d](https://github.com/ArcadeAI/arcade-js/commit/fc4035d1067bb9d47bcf3f018d24d1f7bb878a2e))
+* **internal:** codegen related update ([#80](https://github.com/ArcadeAI/arcade-js/issues/80)) ([42ea2ed](https://github.com/ArcadeAI/arcade-js/commit/42ea2ededb9302fba24e48f7787682a7883140f3))
+* **internal:** codegen related update ([#82](https://github.com/ArcadeAI/arcade-js/issues/82)) ([aa80c39](https://github.com/ArcadeAI/arcade-js/commit/aa80c39657c3cec4818f626a22a4266af1f54e94))
+
+
+### Documentation
+
+* minor formatting changes ([#71](https://github.com/ArcadeAI/arcade-js/issues/71)) ([0801644](https://github.com/ArcadeAI/arcade-js/commit/0801644c04394818799450624e5afd4ae10feff6))
+
 ## 0.2.2 (2024-12-19)
 
 Full Changelog: [v0.2.1...v0.2.2](https://github.com/ArcadeAI/arcade-js/compare/v0.2.1...v0.2.2)

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 ## Setting up the environment
 
-This repository uses [`yarn@v1`](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable).
+This repository uses [`yarn@v1`](https://classic.yarnpkg.com/lang/en/docs/install).
 Other package managers may work but are not officially supported for development.
 
 To set up the repository, run:
@@ -29,10 +29,10 @@ All files in the `examples/` directory are not modified by the generator and can
 …
 ```
 
-```
-chmod +x examples/<your-example>.ts
+```sh
+$ chmod +x examples/<your-example>.ts
 # run the example against your api
-yarn tsn -T examples/<your-example>.ts
+$ yarn tsn -T examples/<your-example>.ts
 ```
 
 ## Using the repository from source

README.md

@@ -4,7 +4,7 @@
 
 This library provides convenient access to the Arcade REST API from server-side TypeScript or JavaScript.
 
-The REST API documentation can be found on [docs.arcade-ai.com](https://docs.arcade-ai.com). The full API of this library can be found in [api.md](api.md).
+The REST API documentation can be found on [docs.arcade.dev](https://docs.arcade.dev). The full API of this library can be found in [api.md](api.md).
 
 It is generated with [Stainless](https://www.stainlessapi.com/).
 
@@ -29,8 +29,7 @@ const client = new Arcade({
 async function main() {
   const executeToolResponse = await client.tools.execute({
     tool_name: 'Google.ListEmails',
-    inputs: { n_emails: 10 },
-    tool_version: '0.1.0',
+    input: { n_emails: 10 },
     user_id: 'user@example.com',
   });
 
@@ -283,7 +282,7 @@ await client.chat.completions.create(
 This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
 
 1. Changes that only affect static types, without breaking runtime behavior.
-2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals)_.
+2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_
 3. Changes that we do not expect to impact the vast majority of users in practice.
 
 We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

SECURITY.md

@@ -20,7 +20,8 @@ or products provided by Arcade please follow the respective company's security r
 
 ### Arcade Terms and Policies
 
-Please contact contact@arcade-ai.com for any questions or concerns regarding security of our services.
+
+Please contact dev@arcade.dev for any questions or concerns regarding security of our services.
 
 ---
 

api.md

@@ -2,6 +2,7 @@
 
 Types:
 
+- <code><a href="./src/resources/shared.ts">AuthorizationContext</a></code>
 - <code><a href="./src/resources/shared.ts">AuthorizationResponse</a></code>
 - <code><a href="./src/resources/shared.ts">Error</a></code>
 
@@ -49,30 +50,28 @@ Types:
 - <code><a href="./src/resources/tools/tools.ts">AuthorizeToolRequest</a></code>
 - <code><a href="./src/resources/tools/tools.ts">ExecuteToolRequest</a></code>
 - <code><a href="./src/resources/tools/tools.ts">ExecuteToolResponse</a></code>
-- <code><a href="./src/resources/tools/tools.ts">ResponseOutput</a></code>
+- <code><a href="./src/resources/tools/tools.ts">ToolDefinition</a></code>
 - <code><a href="./src/resources/tools/tools.ts">ToolExecution</a></code>
 - <code><a href="./src/resources/tools/tools.ts">ToolExecutionAttempt</a></code>
-- <code><a href="./src/resources/tools/tools.ts">ToolListResponse</a></code>
-- <code><a href="./src/resources/tools/tools.ts">ToolGetResponse</a></code>
+- <code><a href="./src/resources/tools/tools.ts">ValueSchema</a></code>
 
 Methods:
 
-- <code title="get /v1/tools/list">client.tools.<a href="./src/resources/tools/tools.ts">list</a>({ ...params }) -> ToolListResponsesOffsetPage</code>
+- <code title="get /v1/tools">client.tools.<a href="./src/resources/tools/tools.ts">list</a>({ ...params }) -> ToolDefinitionsOffsetPage</code>
 - <code title="post /v1/tools/authorize">client.tools.<a href="./src/resources/tools/tools.ts">authorize</a>({ ...params }) -> AuthorizationResponse</code>
 - <code title="post /v1/tools/execute">client.tools.<a href="./src/resources/tools/tools.ts">execute</a>({ ...params }) -> ExecuteToolResponse</code>
-- <code title="get /v1/tools/definition">client.tools.<a href="./src/resources/tools/tools.ts">get</a>({ ...params }) -> ToolGetResponse</code>
+- <code title="get /v1/tools/{name}">client.tools.<a href="./src/resources/tools/tools.ts">get</a>(name) -> ToolDefinition</code>
 
 ## Scheduled
 
 Types:
 
-- <code><a href="./src/resources/tools/scheduled.ts">ScheduledListResponse</a></code>
-- <code><a href="./src/resources/tools/scheduled.ts">ScheduledDetailsResponse</a></code>
+- <code><a href="./src/resources/tools/scheduled.ts">ScheduledGetResponse</a></code>
 
 Methods:
 
-- <code title="get /v1/tools/scheduled">client.tools.scheduled.<a href="./src/resources/tools/scheduled.ts">list</a>() -> ScheduledListResponse</code>
-- <code title="get /v1/tools/scheduled/{id}">client.tools.scheduled.<a href="./src/resources/tools/scheduled.ts">details</a>(id) -> ScheduledDetailsResponse</code>
+- <code title="get /v1/scheduled_tools">client.tools.scheduled.<a href="./src/resources/tools/scheduled.ts">list</a>({ ...params }) -> ToolExecutionsOffsetPage</code>
+- <code title="get /v1/scheduled_tools/{id}">client.tools.scheduled.<a href="./src/resources/tools/scheduled.ts">get</a>(id) -> ScheduledGetResponse</code>
 
 ## Formatted
 
@@ -83,5 +82,5 @@ Types:
 
 Methods:
 
-- <code title="get /v1/tools/formatted/list">client.tools.formatted.<a href="./src/resources/tools/formatted.ts">list</a>({ ...params }) -> FormattedListResponsesOffsetPage</code>
-- <code title="get /v1/tools/formatted/definition">client.tools.formatted.<a href="./src/resources/tools/formatted.ts">get</a>({ ...params }) -> unknown</code>
+- <code title="get /v1/formatted_tools">client.tools.formatted.<a href="./src/resources/tools/formatted.ts">list</a>({ ...params }) -> FormattedListResponsesOffsetPage</code>
+- <code title="get /v1/formatted_tools/{name}">client.tools.formatted.<a href="./src/resources/tools/formatted.ts">get</a>(name, { ...params }) -> unknown</code>

package.json

@@ -1,8 +1,8 @@
 {
   "name": "@arcadeai/arcadejs",
-  "version": "0.2.2",
+  "version": "1.0.0",
   "description": "The official TypeScript library for the Arcade API",
-  "author": "Arcade <contact@arcade-ai.com>",
+  "author": "Arcade <dev@arcade.dev>",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "type": "commonjs",

src/core.ts

@@ -522,9 +522,19 @@ export abstract class APIClient {
 
     const timeout = setTimeout(() => controller.abort(), ms);
 
+    const fetchOptions = {
+      signal: controller.signal as any,
+      ...options,
+    };
+    if (fetchOptions.method) {
+      // Custom methods like 'patch' need to be uppercased
+      // See https://github.com/nodejs/undici/issues/2294
+      fetchOptions.method = fetchOptions.method.toUpperCase();
+    }
+
     return (
       // use undefined this binding; fetch errors if bound to something else in browser/cloudflare
-      this.fetch.call(undefined, url, { signal: controller.signal as any, ...options }).finally(() => {
+      this.fetch.call(undefined, url, fetchOptions).finally(() => {
         clearTimeout(timeout);
       })
     );

src/index.ts

@@ -14,17 +14,15 @@ import {
   AuthorizeToolRequest,
   ExecuteToolRequest,
   ExecuteToolResponse,
-  ResponseOutput,
   ToolAuthorizeParams,
+  ToolDefinition,
+  ToolDefinitionsOffsetPage,
   ToolExecuteParams,
   ToolExecution,
   ToolExecutionAttempt,
-  ToolGetParams,
-  ToolGetResponse,
   ToolListParams,
-  ToolListResponse,
-  ToolListResponsesOffsetPage,
   Tools,
+  ValueSchema,
 } from './resources/tools/tools';
 
 export interface ClientOptions {
@@ -47,15 +45,15 @@ export interface ClientOptions {
    * 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;
+  timeout?: number | undefined;
 
   /**
    * 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;
+  httpAgent?: Agent | undefined;
 
   /**
    * Specify a custom `fetch` function implementation.
@@ -71,23 +69,23 @@ export interface ClientOptions {
    *
    * @default 2
    */
-  maxRetries?: number;
+  maxRetries?: number | undefined;
 
   /**
    * 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;
+  defaultHeaders?: Core.Headers | undefined;
 
   /**
    * 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;
+  defaultQuery?: Core.DefaultQuery | undefined;
 }
 
 /**
@@ -102,7 +100,7 @@ export class Arcade extends Core.APIClient {
    * 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 {string} [opts.baseURL=process.env['ARCADE_BASE_URL'] ?? https://api.arcade.dev] - 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.
@@ -124,7 +122,7 @@ export class Arcade extends Core.APIClient {
     const options: ClientOptions = {
       apiKey,
       ...opts,
-      baseURL: baseURL || `https://api.arcade-ai.com`,
+      baseURL: baseURL || `https://api.arcade.dev`,
     };
 
     super({
@@ -186,7 +184,7 @@ Arcade.Auth = Auth;
 Arcade.Health = Health;
 Arcade.Chat = Chat;
 Arcade.Tools = Tools;
-Arcade.ToolListResponsesOffsetPage = ToolListResponsesOffsetPage;
+Arcade.ToolDefinitionsOffsetPage = ToolDefinitionsOffsetPage;
 export declare namespace Arcade {
   export type RequestOptions = Core.RequestOptions;
 
@@ -216,18 +214,17 @@ export declare namespace Arcade {
     type AuthorizeToolRequest as AuthorizeToolRequest,
     type ExecuteToolRequest as ExecuteToolRequest,
     type ExecuteToolResponse as ExecuteToolResponse,
-    type ResponseOutput as ResponseOutput,
+    type ToolDefinition as ToolDefinition,
     type ToolExecution as ToolExecution,
     type ToolExecutionAttempt as ToolExecutionAttempt,
-    type ToolListResponse as ToolListResponse,
-    type ToolGetResponse as ToolGetResponse,
-    ToolListResponsesOffsetPage as ToolListResponsesOffsetPage,
+    type ValueSchema as ValueSchema,
+    ToolDefinitionsOffsetPage as ToolDefinitionsOffsetPage,
     type ToolListParams as ToolListParams,
     type ToolAuthorizeParams as ToolAuthorizeParams,
     type ToolExecuteParams as ToolExecuteParams,
-    type ToolGetParams as ToolGetParams,
   };
 
+  export type AuthorizationContext = API.AuthorizationContext;
   export type AuthorizationResponse = API.AuthorizationResponse;
   export type Error = API.Error;
 }