@composio/client 0.1.0-alpha.1 → 0.1.0-alpha.6

package/src/client.ts

@@ -12,6 +12,7 @@ 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';
@@ -40,6 +41,14 @@ import {
   AuthConfigUpdateStatusResponse,
   AuthConfigs,
 } from './resources/auth-configs';
+import {
+  Cli,
+  CliCreateSessionResponse,
+  CliLinkSessionParams,
+  CliLinkSessionResponse,
+  CliRetrieveSessionParams,
+  CliRetrieveSessionResponse,
+} from './resources/cli';
 import {
   ConnectedAccountCreateParams,
   ConnectedAccountCreateResponse,
@@ -92,6 +101,20 @@ import {
 import { readEnv } from './internal/utils/env';
 import { formatRequestDetails, loggerFor } from './internal/utils/log';
 import { isEmptyObj } from './internal/utils/values';
+import {
+  Mcp,
+  McpCreateParams,
+  McpCreateResponse,
+  McpDeleteResponse,
+  McpListParams,
+  McpListResponse,
+  McpRetrieveAppResponse,
+  McpRetrieveResponse,
+  McpUpdateParams,
+  McpUpdateResponse,
+  McpValidateParams,
+  McpValidateResponse,
+} from './resources/mcp/mcp';
 import { Org } from './resources/org/org';
 import {
   TriggerInstanceListActiveParams,
@@ -130,7 +153,7 @@ export interface ClientOptions {
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
    *
-   * Defaults to process.env['COMPOSIO_SDK_BASE_URL'].
+   * Defaults to process.env['COMPOSIO_BASE_URL'].
    */
   baseURL?: string | null | undefined;
 
@@ -182,7 +205,7 @@ export interface ClientOptions {
   /**
    * Set the log level.
    *
-   * Defaults to process.env['COMPOSIO_SDK_LOG'] or 'warn' if it isn't set.
+   * Defaults to process.env['COMPOSIO_LOG'] or 'warn' if it isn't set.
    */
   logLevel?: LogLevel | undefined;
 
@@ -195,9 +218,9 @@ export interface ClientOptions {
 }
 
 /**
- * API Client for interfacing with the Composio SDK API.
+ * API Client for interfacing with the Composio API.
  */
-export class ComposioSDK {
+export class Composio {
   apiKey: string;
 
   baseURL: string;
@@ -213,11 +236,11 @@ export class ComposioSDK {
   private _options: ClientOptions;
 
   /**
-   * API Client for interfacing with the Composio SDK API.
+   * API Client for interfacing with the Composio API.
    *
    * @param {string | undefined} [opts.apiKey=process.env['COMPOSIO_API_KEY'] ?? undefined]
    * @param {Environment} [opts.environment=production] - Specifies the environment URL to use for the API.
-   * @param {string} [opts.baseURL=process.env['COMPOSIO_SDK_BASE_URL'] ?? https://backend.composio.dev] - Override the default base URL for the API.
+   * @param {string} [opts.baseURL=process.env['COMPOSIO_BASE_URL'] ?? https://backend.composio.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 {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
    * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
@@ -226,13 +249,13 @@ export class ComposioSDK {
    * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
    */
   constructor({
-    baseURL = readEnv('COMPOSIO_SDK_BASE_URL'),
+    baseURL = readEnv('COMPOSIO_BASE_URL'),
     apiKey = readEnv('COMPOSIO_API_KEY'),
     ...opts
   }: ClientOptions = {}) {
     if (apiKey === undefined) {
-      throw new Errors.ComposioSDKError(
-        "The COMPOSIO_API_KEY environment variable is missing or empty; either provide it, or instantiate the ComposioSDK client with an apiKey option, like new ComposioSDK({ apiKey: 'My API Key' }).",
+      throw new Errors.ComposioError(
+        "The COMPOSIO_API_KEY environment variable is missing or empty; either provide it, or instantiate the Composio client with an apiKey option, like new Composio({ apiKey: 'My API Key' }).",
       );
     }
 
@@ -244,20 +267,20 @@ export class ComposioSDK {
     };
 
     if (baseURL && opts.environment) {
-      throw new Errors.ComposioSDKError(
-        'Ambiguous URL; The `baseURL` option (or COMPOSIO_SDK_BASE_URL env var) and the `environment` option are given. If you want to use the environment you must pass baseURL: null',
+      throw new Errors.ComposioError(
+        'Ambiguous URL; The `baseURL` option (or COMPOSIO_BASE_URL env var) and the `environment` option are given. If you want to use the environment you must pass baseURL: null',
       );
     }
 
     this.baseURL = options.baseURL || environments[options.environment || 'production'];
-    this.timeout = options.timeout ?? ComposioSDK.DEFAULT_TIMEOUT /* 1 minute */;
+    this.timeout = options.timeout ?? Composio.DEFAULT_TIMEOUT /* 1 minute */;
     this.logger = options.logger ?? console;
     const defaultLogLevel = 'warn';
     // Set default logLevel early so that we can log a warning in parseLogLevel.
     this.logLevel = defaultLogLevel;
     this.logLevel =
       parseLogLevel(options.logLevel, 'ClientOptions.logLevel', this) ??
-      parseLogLevel(readEnv('COMPOSIO_SDK_LOG'), "process.env['COMPOSIO_SDK_LOG']", this) ??
+      parseLogLevel(readEnv('COMPOSIO_LOG'), "process.env['COMPOSIO_LOG']", this) ??
       defaultLogLevel;
     this.fetchOptions = options.fetchOptions;
     this.maxRetries = options.maxRetries ?? 2;
@@ -278,27 +301,11 @@ export class ComposioSDK {
   }
 
   protected authHeaders(opts: FinalRequestOptions): NullableHeaders | undefined {
-    return buildHeaders([{ 'X-Api-Key': this.apiKey }]);
+    return buildHeaders([{ 'x-api-key': this.apiKey }]);
   }
 
-  /**
-   * 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.ComposioSDKError(
-          `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 {
@@ -659,17 +666,17 @@ export class ComposioSDK {
   }
 
   buildRequest(
-    options: FinalRequestOptions,
+    inputOptions: FinalRequestOptions,
     { retryCount = 0 }: { retryCount?: number } = {},
   ): { req: FinalizedRequestInit; url: string; timeout: number } {
-    options = { ...options };
+    const options = { ...inputOptions };
     const { method, path, query } = options;
 
     const url = this.buildURL(path!, query as Record<string, unknown>);
     if ('timeout' in options) validatePositiveInteger('timeout', options.timeout);
     options.timeout = options.timeout ?? this.timeout;
     const { bodyHeaders, body } = this.buildBody({ options });
-    const reqHeaders = this.buildHeaders({ options, method, bodyHeaders, retryCount });
+    const reqHeaders = this.buildHeaders({ options: inputOptions, method, bodyHeaders, retryCount });
 
     const req: FinalizedRequestInit = {
       method,
@@ -759,10 +766,10 @@ export class ComposioSDK {
     }
   }
 
-  static ComposioSDK = this;
+  static Composio = this;
   static DEFAULT_TIMEOUT = 60000; // 1 minute
 
-  static ComposioSDKError = Errors.ComposioSDKError;
+  static ComposioError = Errors.ComposioError;
   static APIError = Errors.APIError;
   static APIConnectionError = Errors.APIConnectionError;
   static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
@@ -788,18 +795,22 @@ export class ComposioSDK {
   tools: API.Tools = new API.Tools(this);
   triggerInstances: API.TriggerInstances = new API.TriggerInstances(this);
   triggersTypes: API.TriggersTypes = new API.TriggersTypes(this);
+  cli: API.Cli = new API.Cli(this);
+  mcp: API.Mcp = new API.Mcp(this);
 }
-ComposioSDK.AuthConfigs = AuthConfigs;
-ComposioSDK.ConnectedAccounts = ConnectedAccounts;
-ComposioSDK.Trigger = Trigger;
-ComposioSDK.ActionExecution = ActionExecution;
-ComposioSDK.Org = Org;
-ComposioSDK.TeamMembers = TeamMembers;
-ComposioSDK.Toolkits = Toolkits;
-ComposioSDK.Tools = Tools;
-ComposioSDK.TriggerInstances = TriggerInstances;
-ComposioSDK.TriggersTypes = TriggersTypes;
-export declare namespace ComposioSDK {
+Composio.AuthConfigs = AuthConfigs;
+Composio.ConnectedAccounts = ConnectedAccounts;
+Composio.Trigger = Trigger;
+Composio.ActionExecution = ActionExecution;
+Composio.Org = Org;
+Composio.TeamMembers = TeamMembers;
+Composio.Toolkits = Toolkits;
+Composio.Tools = Tools;
+Composio.TriggerInstances = TriggerInstances;
+Composio.TriggersTypes = TriggersTypes;
+Composio.Cli = Cli;
+Composio.Mcp = Mcp;
+export declare namespace Composio {
   export type RequestOptions = Opts.RequestOptions;
 
   export {
@@ -895,4 +906,28 @@ export declare namespace ComposioSDK {
     type TriggersTypeRetrieveEnumResponse as TriggersTypeRetrieveEnumResponse,
     type TriggersTypeListParams as TriggersTypeListParams,
   };
+
+  export {
+    Cli as Cli,
+    type CliCreateSessionResponse as CliCreateSessionResponse,
+    type CliLinkSessionResponse as CliLinkSessionResponse,
+    type CliRetrieveSessionResponse as CliRetrieveSessionResponse,
+    type CliLinkSessionParams as CliLinkSessionParams,
+    type CliRetrieveSessionParams as CliRetrieveSessionParams,
+  };
+
+  export {
+    Mcp as Mcp,
+    type McpCreateResponse as McpCreateResponse,
+    type McpRetrieveResponse as McpRetrieveResponse,
+    type McpUpdateResponse as McpUpdateResponse,
+    type McpListResponse as McpListResponse,
+    type McpDeleteResponse as McpDeleteResponse,
+    type McpRetrieveAppResponse as McpRetrieveAppResponse,
+    type McpValidateResponse as McpValidateResponse,
+    type McpCreateParams as McpCreateParams,
+    type McpUpdateParams as McpUpdateParams,
+    type McpListParams as McpListParams,
+    type McpValidateParams as McpValidateParams,
+  };
 }

package/src/core/api-promise.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { type ComposioSDK } from '../client';
+import { type Composio } from '../client';
 
 import { type PromiseOrValue } from '../internal/types';
 import { APIResponseProps, defaultParseResponse } from '../internal/parse';
@@ -11,13 +11,13 @@ import { APIResponseProps, defaultParseResponse } from '../internal/parse';
  */
 export class APIPromise<T> extends Promise<T> {
   private parsedPromise: Promise<T> | undefined;
-  #client: ComposioSDK;
+  #client: Composio;
 
   constructor(
-    client: ComposioSDK,
+    client: Composio,
     private responsePromise: Promise<APIResponseProps>,
     private parseResponse: (
-      client: ComposioSDK,
+      client: Composio,
       props: APIResponseProps,
     ) => PromiseOrValue<T> = defaultParseResponse,
   ) {

package/src/core/error.ts

@@ -2,13 +2,13 @@
 
 import { castToError } from '../internal/errors';
 
-export class ComposioSDKError extends Error {}
+export class ComposioError extends Error {}
 
 export class APIError<
   TStatus extends number | undefined = number | undefined,
   THeaders extends Headers | undefined = Headers | undefined,
   TError extends Object | undefined = Object | undefined,
-> extends ComposioSDKError {
+> extends ComposioError {
   /** HTTP status for the response that caused the error */
   readonly status: TStatus;
   /** HTTP headers for the response that caused the error */

package/src/core/resource.ts

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

package/src/index.ts

@@ -1,12 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { ComposioSDK as default } from './client';
+export { Composio as default } from './client';
 
 export { type Uploadable, toFile } from './core/uploads';
 export { APIPromise } from './core/api-promise';
-export { ComposioSDK, type ClientOptions } from './client';
+export { Composio, type ClientOptions } from './client';
 export {
-  ComposioSDKError,
+  ComposioError,
   APIError,
   APIConnectionError,
   APIConnectionTimeoutError,

package/src/internal/parse.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import type { FinalRequestOptions } from './request-options';
-import { type ComposioSDK } from '../client';
+import { type Composio } from '../client';
 import { formatRequestDetails, loggerFor } from './utils/log';
 
 export type APIResponseProps = {
@@ -13,7 +13,7 @@ export type APIResponseProps = {
   startTime: number;
 };
 
-export async function defaultParseResponse<T>(client: ComposioSDK, props: APIResponseProps): Promise<T> {
+export async function defaultParseResponse<T>(client: Composio, props: APIResponseProps): Promise<T> {
   const { response, requestLogID, retryOfRequestLogID, startTime } = props;
   const body = await (async () => {
     // fetch refuses to read the body when the status code is 204.

package/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.

package/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.

package/src/internal/qs/formats.ts

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

package/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';