@composio/client 2.0.0-rc.9 → 2.0.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/MIGRATION.md

@@ -0,0 +1,164 @@
+# Upgrade to @composio/client 2.0
+
+By default, the 2.0 client refuses to send credentials over plain HTTP unless the hostname is
+loopback. For a trusted development backend such as Docker's host gateway, opt in to the exact
+configured origin:
+
+```ts
+const composio = new Composio({
+  auth: Auth.project(apiKey),
+  baseURL: 'http://host.docker.internal:9900',
+  allowInsecureHTTP: true,
+})
+```
+
+The equivalent environment configuration, for `Composio.fromEnv`, is:
+
+```sh
+COMPOSIO_BASE_URL=http://host.docker.internal:9900 \
+COMPOSIO_ALLOW_INSECURE_HTTP=1
+```
+
+The opt-in records the resolved scheme, hostname, and port. Mutating `baseURL` cannot broaden it,
+and `withOptions({ baseURL: ... })` requires `allowInsecureHTTP: true` again when the origin
+changes. Redirects to another origin remain credential-free.
+
+### Changed in 2.0.0
+
+| Change | Migration |
+| --- | --- |
+| Trigger upsert responses and active-list items require `type`, `fallback_reason` and `polling_interval` | Update typed fixtures/mocks to include all three keys. `type` is `webhook` or `poll`; the other two keys accept `null`. This also applies to Effect stream items |
+| Trigger upsert accepts optional `type` and `polling_interval` | Use `type: 'poll'` or `'webhook'` to choose a mechanism; the interval is an integer in minutes (1–10080, subject to toolkit limits). Omit them to keep server selection |
+| POST and PATCH no longer retry by default on the Promise client, matching Effect | Set `maxRetries` in the individual call's request options only when repeating that operation is safe. A client-level setting or `idempotencyKey` does not opt writes into retries |
+
+### Changed in 2.0.0-rc.23
+
+| Change | Migration |
+| --- | --- |
+| `client.cli.createCodactFailure` moved to `client._internal.cli.createCodactFailure` (Apollo now tags it `x-internal`) | Import `@composio/client/internal` and call it there. Its types come from `@composio/client/resources/_internal/cli`; `@composio/client/resources/cli` no longer exists. Its Effect response schema moved to `@composio/client/effect/schemas/_internal/cli/create-codact-failure`. The wire is unchanged |
+| `client.org.clanker.createClaim` is removed, with `@composio/client/resources/org/clanker` (Apollo removed `POST /api/v3.1/org/clanker/create_claim`) | None: the endpoint no longer exists |
+| `sessionConfigs.list` no longer accepts `search` (Apollo removed the filter) | Drop `search` from the query and filter the returned configs yourself |
+
+Two new internal operations are under `client._internal`: `consumer.permissions.resolve()` and
+`org.consumer.retrieveConfig()`. Each removal has a ledger entry; `search` is a `properties-removed`
+entry.
+
+### Moved in 2.0.0-rc.22
+
+The operations the spec tags `x-internal` moved under `client._internal`, which is typed only through
+`@composio/client/internal` (see [Internal operations](./README.md#internal-operations)). The wire is unchanged.
+The ledger declares each as a removal; `pnpm test:pack` holds the subpaths.
+
+| Moved | Now |
+| --- | --- |
+| `client.cli.createSession`, `getSession` | `client._internal.cli.createSession`, `getSession` |
+| `client.cli.realtime.*` | `client._internal.cli.realtime.*` |
+| `client.logs.tools.*`, `client.logs.triggers.*` | `client._internal.logs.tools.*`, `client._internal.logs.triggers.*` |
+| `client.org.consumer.*` | `client._internal.org.consumer.*` |
+| Their types, from `@composio/client/resources/cli`, `resources/cli/realtime`, `resources/logs`, `resources/logs/tools`, `resources/logs/triggers`, `resources/org/consumer*` | The same names from `@composio/client/resources/_internal/<same path>` |
+
+`client.logs.createToolExecution` and `client.logs.retrieveToolExecution` are not tagged and stay
+where they were. `client.cli.createCodactFailure` stayed too, until rc.23.
+
+### Changed in 2.0.0-rc.22
+
+| Change | Migration |
+| --- | --- |
+| `toolRouter.session.execute`, `executeMeta` and `proxyExecute` can return `result_type: 'blocked'` | Handle that branch before reading `data`, `error`, `status` or `headers`. Read `reason.type`, `reason.hook_id` and `message` instead. `request_blocked` means the tool did not run; `response_blocked` means it ran and its response was withheld. `log_id` is optional on blocked tool executions |
+| Execution outcomes may include `hook_results` | Treat it as optional. An entry with `status: 'evaluated'` has `outcome: 'continue' \| 'block'`; `status: 'unavailable'` has no outcome. Python callers must also handle the new `SessionExecuteBlockedResponse`, `SessionExecuteMetaBlockedResponse` and `SessionProxyExecuteBlockedResponse` members of each `*Result` union |
+| Trigger-type list items and retrieve responses require `types` | Add a non-empty `types` array of `'webhook'` and/or `'poll'` to typed fixtures and mocks. The older `type` field is deprecated |
+| `org.consumer.project.resolve` requires response `user_id` | Add the authenticated user's id to typed response fixtures and mocks; `consumer_user_id` remains a separate field |
+| Saved session configurations include `require_approval` lists | Handle toolkit/tool entries containing only `{ require_approval: [...] }`, as well as entries with `enable`, `disable` or tool tags. Session-wide and per-toolkit tags may also contain `require_approval` |
+| Project creation no longer declares `config.require_mcp_api_key` | Remove it from project-creation inputs. The upstream schema declares no replacement. `config.enable_instant` controls Instant Toolkits and is unrelated to MCP authentication |
+
+The removed project property has a `properties-removed` ledger entry. The previous-release gate
+checks named property paths as well as assignability, so removing an optional key cannot silently
+pass both structural checks.
+
+### Removed in 2.0.0-rc.21
+
+The last members of the `Composio` class that existed only to look like the Stainless build. None is a
+gate subject, so the ledger declares nothing; `pnpm test:pack` holds all three.
+
+| Removed | Migration |
+| --- | --- |
+| `client.request({ method, path, ... })` | The raw verb for the method: `client.get(path, opts)`, `post`, `patch`, `put`, `delete`, which take the same `query`, `body` and request options |
+| `Composio.Composio` | The class itself: `import { Composio } from '@composio/client'` or the default import |
+| `Composio.DEFAULT_TIMEOUT` | None: the default is one minute, and `timeout` overrides it |
+
+### Removed in 2.0.0-rc.20
+
+The Stainless structure goes. The two removal classes are declared rule entries in
+`packages/codegen/assignability-ledger.json`; the export spellings are held by `pnpm test:pack`.
+
+| Removed | Migration |
+| --- | --- |
+| Resource classes (`ToolRouter`, `Tools`, `ConnectedAccounts`, ... as values) and `Composio.Tools`-style statics | A resource is a plain object typed by an interface of the same name. `import type { Tools } from '@composio/client/resources/tools'` still works as a type; `Composio['tools']` is the same type. `instanceof` a resource class has no replacement |
+| Namespace-merged nested types (`SessionToolkitsResponse.Item`, `LinkCreateParams.Experimental`) | Indexed access: `SessionToolkitsResponse['items'][number]`, `NonNullable<LinkCreateParams['experimental']>` |
+| The `Composio` namespace (`Composio.RequestOptions`, `Composio.ToolListResponse`, ...) | Import the type: `import type { RequestOptions } from '@composio/client'`, `import type { ToolListResponse } from '@composio/client/resources/tools'` |
+| `@composio/client/resources`, `/resources.js`, `/resources.mjs`, `/resources/index` | The resource's own subpath: `@composio/client/resources/mcp` |
+| `.js` and `.mjs` deep subpaths (`/resources/tool-router/session/session.mjs`), `/pagination.js`, `/pagination.mjs` | The extensionless spelling: `/resources/tool-router/session/session`, `/pagination` |
+| `client.migration`, `client.project.config` | None: neither held an operation |
+
+### Removed in 2.0.0-rc.19
+
+The two option removals are declared entries in `packages/codegen/assignability-ledger.json`. The
+other rows are class members the type check does not pin, listed so an upgrade can find them.
+
+| Removed | Migration |
+| --- | --- |
+| `environment: 'production' \| 'staging' \| 'local'` (root `ClientOptions`) | `baseURL: ENVIRONMENTS.staging` or `ENVIRONMENTS.local` — the frozen origin table, exported since rc.20; omitting it means production |
+| `Logger` (exported interface) | `logger` takes a `Console`-shaped object (`Pick<Console, 'debug' \| 'info' \| 'warn' \| 'error'>`) and defaults to `console`. An adapter that forwards to another logger is the same four methods |
+| `client.apiKey`, `userApiKey`, `orgApiKey` (read-only since rc.18) | Keep your own copy of the key; `client.authMode` says which mode is configured |
+| `client.logger` | None: the sink is the client's own. Pass a different one to `withOptions({ logger })` |
+| Assigning `client.baseURL`, `maxRetries`, `timeout` or `logLevel` | `withOptions({ ... })`, which re-runs every validation. The four stay readable; `logLevel` reads the effective level (`'warn'` by default) |
+| `deprecationNotices: 'warn' \| 'off'` (`./effect` `ComposioClientOptions`) | The application's `Logger` and `References.MinimumLogLevel`; a logger that drops records matching `isDeprecationNotice` is `'off'` |
+| `layerFetch(options)` (`./effect`) | `layer(options).pipe(Layer.provide(FetchHttpClient.layer))` |
+
+Python removes `default_query` and the `api_key`, `user_api_key` and `org_api_key` reads, and makes
+`base_url`, `max_retries` and `timeout` read-only; `environment=` stays. See
+[`python/README.md`](./python/MIGRATION.md).
+
+### Removed in 2.0.0-rc.18
+
+Each removal is a declared entry in `packages/codegen/assignability-ledger.json`. The other rows are
+behaviour the type check cannot see, listed so an upgrade can find them.
+
+| Removed | Migration |
+| --- | --- |
+| `apiKey` (root `ClientOptions` and `./effect` `ComposioClientOptions`) | `auth: Auth.project(key)` |
+| `userApiKey` | `auth: Auth.user(key)`, which sends the user key on every request. The old per-operation selection is `Auth.auto({ project, user, organization })` |
+| `orgApiKey` | `auth: Auth.organization(key)`, or `Auth.auto({ ... })` |
+| `apiKey: null` plus a credential in `defaultHeaders` | the `auth` that credential is. While `auth` is not `none`, `defaultHeaders`, `COMPOSIO_CUSTOM_HEADERS` and a call's `headers` cannot name `x-api-key`, `x-user-api-key` or `x-org-api-key` |
+| `x-api-key` overriding the credential for one call | a second client: `withOptions({ auth: Auth.project(key) })` on the root, `make({ ...options, auth: Auth.project(key) }, httpClient)` on `./effect` |
+| `x-org-id`, `x-project-id` in `defaultHeaders` | `scope: { organizationId, projectId }`, which reserves both names. Without `scope` they are still ordinary headers |
+| the constructor reading `COMPOSIO_*` from the process | `Composio.fromEnv(process.env, overrides)`; nothing else reads the environment. `new Composio()` with no options is gone with it |
+| `layerConfig({ apiKey: null })` | `layerConfig({ auth: Auth.none() })`; an override replaces the whole `auth` |
+| `layer()`, `layerFetch()` with no options | pass the options, `auth` included |
+| assigning `client.apiKey`, `userApiKey` or `orgApiKey` | `withOptions({ auth })`. The three fields stayed readable until rc.19; keep your own copy of a key you need |
+| `Credential` on `./effect` accepting `null` | `Auth.none()`. It now also accepts a function that returns a key |
+
+Python makes the same change: `auth=ProjectAuth(key)` (and `UserAuth`, `OrganizationAuth`,
+`AutoAuth`, `NoAuth`) and `scope=Scope(...)`, see [`python/README.md`](./python/MIGRATION.md).
+
+### Changed in 2.0.0-rc.17
+
+`defaultHeaders`, `COMPOSIO_CUSTOM_HEADERS` and per-call `headers` refuse the library headers
+(`x-client-library`, `x-client-library-version`, `x-client-language`), and refuse every identity
+header once `identity` is set. A wrapper that set its product headers through `defaultHeaders`
+moves them into `identity` (see [Identify the calling product](./README.md#identify-the-calling-product)).
+Python takes `identity=ClientIdentity(...)` under the same rule. The type surface is unchanged
+apart from the added option, so the release declares no ledger entry.
+
+### Removed in 2.0.0-rc.16
+
+Each row is a declared entry in `packages/codegen/assignability-ledger.json`, the list of what a
+release changes against the previous published version.
+
+| Removed | Migration |
+| --- | --- |
+| `fetch: f` (constructor) | `transport: createFetchTransport({ fetch: f })` |
+| `fetchOptions: { cache: 'no-store' }` (constructor) | `transport: createFetchTransport({ defaults: { cache: 'no-store' } })`. The defaults cannot set `method`, `headers`, `body`, `signal` or `redirect`, which the client owns |
+| `fetchOptions` (per call, in `RequestOptions`) | None: `headers`, `timeout`, `signal` and `idempotencyKey` stay, and transport-level defaults go through `createFetchTransport({ defaults })` |
+| `defaultQuery` (root `ClientOptions` and `./effect` `ComposioClientOptions`) | None: generated methods own their query, and the raw methods (`get`, `post`, ...) take an explicit `query` |
+| `custom.deleteToolkit(slug, options)` | `custom.deleteToolkit(slug, query, options)` — pass request options third, as on every other `(id, params?, options?)` method. The runtime guard that recognized an options bag in the params position is gone with the overload |