feat: add types (#842)

<!-- ELLIPSIS_HIDDEN -->


> [!IMPORTANT]
> Enhancements include new DTO properties, field renames for
consistency, version update, and improved error handling across multiple
files.
> 
>   - **Behavior**:
> - Added `labels` to `ConnectionWithAppData`, `ConnectionParams`,
`GetConnectionsQueryDto`, `InitiateConnectionPayloadDto`,
`UpdateConnectionLabelsPayloadDto` in `schemas.gen.ts` and
`types.gen.ts`.
> - Added `isNew` to `TriggerResponseDTO` in `schemas.gen.ts` and
`types.gen.ts`.
> - Added `page` and `offset` to `ActionsQueryDTO` in `schemas.gen.ts`
and `types.gen.ts`.
> - Updated `CreateConnectorPayloadDTO` to make `appId` optional and
added `appName` in `schemas.gen.ts` and `types.gen.ts`.
>   - **Renames**:
> - Renamed `displayName` to `display_name`, `expectedFromCustomer` to
`expected_from_customer`, `isSecret` to `is_secret` in
`ExpectedInputFieldsDTO`.
>   - **Services**:
> - Added `updateConnectionData` method to `ConnectionsService` in
`connectedAccounts.ts`.
>   - **Misc**:
>     - Updated version in `package.json` from `0.2.8-4` to `0.2.8-5`.
> - Improved error handling in `error.ts` with more detailed messages
and suggestions.
> 
> <sup>This description was created by </sup>[<img alt="Ellipsis"
src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=SamparkAI%2Fcomposio&utm_source=github&utm_medium=referral)<sup>
for c83eb17. It will automatically
update as commits are pushed.</sup>


<!-- ELLIPSIS_HIDDEN -->

.github/workflows/run_js_test.yml

@@ -32,7 +32,7 @@ jobs:
     - name: pnpm build
       run: cd js && pnpm build
     - name: run test
-      run: cd js && pnpm test:coverage
+      run: cd js && pnpm test:coverage --max-workers 16
 
 
     - name: Upload `coverage` folder to R2

docs/api-reference/admin/clear-cache.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /api/v1/clear-cache
+---

docs/api-reference/auth/get-user-info.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /api/v1/client/auth/client_info
+---

docs/api-reference/connections/update-connection-data.mdx

@@ -0,0 +1,3 @@
+---
+openapi: patch /api/v1/connectedAccounts/{connectedAccountId}/data
+---

js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "composio-core",
-  "version": "0.2.9-3",
+  "version": "0.2.9-7",
   "description": "",
   "main": "lib/src/index.js",
   "scripts": {

js/src/frameworks/cloudflare.ts

@@ -53,6 +53,7 @@ export class CloudflareToolSet extends BaseComposioToolSet {
     apps?: Sequence<string>;
     tags?: Optional<Array<string>>;
     useCase?: Optional<string>;
+    usecaseLimit?: Optional<number>;
     filterByAvailableApps?: Optional<boolean>;
   }): Promise<Sequence<AiTextGenerationToolInput>> {
     const actions = await this.getToolsSchema(filters);

js/src/frameworks/langchain.ts

@@ -65,6 +65,7 @@ export class LangchainToolSet extends BaseComposioToolSet {
             apps?: Sequence<string>;
             tags?: Optional<Array<string>>;
             useCase?: Optional<string>;
+            usecaseLimit?: Optional<number>;
             filterByAvailableApps?: Optional<boolean>;
         },
         entityId: Optional<string> = null

js/src/frameworks/openai.spec.ts

@@ -33,6 +33,16 @@ describe("Apps class tests", () => {
         expect(Object.keys(tools).length).toBe(1);
     });
 
+    it("should get tools with usecase limit", async () => {
+        const tools = await openAIToolset.getTools({
+            useCase: "follow user",
+            apps: ["github"],
+            useCaseLimit: 1
+        });
+
+        expect(tools.length).toBe(1);
+    });
+
     it("check if getTools -> actions are coming", async () => {
         const tools = await openAIToolset.getTools({
             actions: ['GITHUB_GITHUB_API_ROOT']

js/src/frameworks/openai.ts

@@ -46,6 +46,7 @@ export class OpenAIToolSet extends BaseComposioToolSet {
             apps?: Sequence<string>;
             tags?: Optional<Array<string>>;
             useCase?: Optional<string>;
+            useCaseLimit?: Optional<number>;
             filterByAvailableApps?: Optional<boolean>;
         },
         entityId?: Optional<string>

js/src/frameworks/vercel.ts

@@ -51,6 +51,7 @@ export class VercelAIToolSet extends BaseComposioToolSet {
     apps?: Array<string>;
     tags?: Optional<Array<string>>;
     useCase?: Optional<string>;
+    usecaseLimit?: Optional<number>;
     filterByAvailableApps?: Optional<boolean>;
   }): Promise<{ [key: string]: any }> {
 
@@ -59,7 +60,7 @@ export class VercelAIToolSet extends BaseComposioToolSet {
       ...(filters?.tags && { tags: filters?.tags?.join(",") }),
       ...(filters?.useCase && { useCase: filters?.useCase }),
       ...(filters?.actions && { actions: filters?.actions?.join(",") }),
-      ...(filters?.actions && { actions: filters?.actions?.join(",") }),
+      ...(filters?.usecaseLimit && { usecaseLimit: filters?.usecaseLimit }),
       filterByAvailableApps: filters?.filterByAvailableApps ?? undefined
     });
 

js/src/sdk/base.toolset.spec.ts

@@ -69,4 +69,14 @@ describe("ComposioToolSet class tests", () => {
 
     });
 
+    it("should get tools with usecase limit", async () => {
+        const tools = await toolset.getToolsSchema({
+            useCase: "follow user",
+            apps: ["github"],
+            useCaseLimit: 1
+        });
+
+        expect(tools.length).toBe(1);
+    });
+
 });

js/src/sdk/base.toolset.ts

@@ -129,6 +129,7 @@ export class ComposioToolSet {
             apps?: Array<string>;
             tags?: Optional<Array<string>>;
             useCase?: Optional<string>;
+            useCaseLimit?: Optional<number>;
             filterByAvailableApps?: Optional<boolean>;
         },
         entityId?: Optional<string>
@@ -140,6 +141,7 @@ export class ComposioToolSet {
             ...(filters?.tags && { tags: filters?.tags?.join(",") }),
             ...(filters?.useCase && { useCase: filters?.useCase }),
             ...(filters?.actions && { actions: filters?.actions?.join(",") }),
+            ...(filters?.useCaseLimit && { usecaseLimit: filters?.useCaseLimit }),
             filterByAvailableApps: filters?.filterByAvailableApps ?? undefined
          });
         const localActions = new Map<string, NonNullable<GetListActionsResponse["items"]>[0]>();

js/src/sdk/client/schemas.gen.ts

@@ -797,7 +797,7 @@ export const $ExpectedInputFieldsDTO = {
             type: 'string',
             description: 'Description of the field'
         },
-        displayName: {
+        display_name: {
             type: 'string',
             description: 'Display name of the field'
         },
@@ -809,17 +809,17 @@ export const $ExpectedInputFieldsDTO = {
             type: 'boolean',
             description: 'Whether the field is required'
         },
-        expectedFromCustomer: {
+        expected_from_customer: {
             type: 'boolean',
             description: 'Whether the field is expected from customer'
         },
-        isSecret: {
+        is_secret: {
             type: 'boolean',
             description: 'Whether the field is a secret'
         }
     },
     type: 'object',
-    required: ['name', 'type', 'description', 'displayName', 'default', 'required', 'expectedFromCustomer', 'isSecret']
+    required: ['name', 'type', 'description', 'display_name', 'default', 'required', 'expected_from_customer', 'is_secret']
 } as const;
 
 export const $GetConnectorInfoResDTO = {
@@ -1161,6 +1161,12 @@ export const $ConnectionWithAppData = {
                 '$ref': '#/components/schemas/MemberInfoResDTO'
             },
             type: 'object'
+        },
+        labels: {
+            items: {
+                type: 'string'
+            },
+            type: 'array'
         }
     },
     type: 'object',
@@ -1316,6 +1322,12 @@ export const $ConnectionParams = {
                 '$ref': '#/components/schemas/MemberInfoResDTO'
             },
             type: 'object'
+        },
+        labels: {
+            items: {
+                type: 'string'
+            },
+            type: 'array'
         }
     },
     type: 'object',

js/src/sdk/client/types.gen.ts

@@ -496,7 +496,7 @@ export type AppQueryDTO = {
      */
     additionalFields?: string;
     /**
-     * Whether to include local tools or not
+     * Enter 'true' or 'false'
      */
     includeLocal?: string;
 };
@@ -571,7 +571,7 @@ export type ExpectedInputFieldsDTO = {
     /**
      * Display name of the field
      */
-    displayName: string;
+    display_name: string;
     /**
      * Default value of the field
      */
@@ -585,11 +585,11 @@ export type ExpectedInputFieldsDTO = {
     /**
      * Whether the field is expected from customer
      */
-    expectedFromCustomer: boolean;
+    expected_from_customer: boolean;
     /**
      * Whether the field is a secret
      */
-    isSecret: boolean;
+    is_secret: boolean;
 };
 
 export type GetConnectorInfoResDTO = {
@@ -810,6 +810,7 @@ export type ConnectionWithAppData = {
     member: {
         [key: string]: unknown;
     };
+    labels?: Array<(string)>;
 };
 
 export type GetConnectionsResult = {
@@ -853,7 +854,6 @@ export type ActionExecutionResDto = {
 
 export type ConnectionParams = {
     integrationId: string;
-    labels?: Array<(string)>;
     connectionParams?: {
         [key: string]: unknown;
     };
@@ -878,6 +878,7 @@ export type ConnectionParams = {
     member: {
         [key: string]: unknown;
     };
+    labels?: Array<(string)>;
 };
 
 export type ToggleConnectedAccountResponseDTO = {
@@ -2598,7 +2599,7 @@ export type ListActionsV2Data = {
         showEnabledOnly?: boolean;
         tags?: string;
         useCase?: string;
-        usecaseLimit?: number;
+        useCaseLimit?: number;
     };
 };
 

js/src/sdk/models/Entity.spec.ts

@@ -1,20 +1,36 @@
 import { describe, it, expect } from "@jest/globals";
 import { getBackendClient } from "../testUtils/getBackendClient";
 import { Entity } from "./Entity";
+import { ConnectedAccounts } from "./connectedAccounts";
 
 describe("Entity class tests", () => {
     let backendClient = getBackendClient();
     let entity: Entity;
     let triggerId: string;
+    let connectedAccounts: ConnectedAccounts;
 
     beforeAll(() => {
         entity = new Entity(backendClient, "default");
+        connectedAccounts = new ConnectedAccounts(backendClient);
+
     });
 
     it("should create an Entity instance with 'default' id", () => {
         expect(entity).toBeInstanceOf(Entity);
         expect(entity.id).toBe("default");
     });
+
+
+    it("should create for different entities", async () => {
+        const entityId = "test-entity";
+        const entity2 = new Entity(backendClient, entityId);
+        const connection = await entity2.initiateConnection("github");
+        expect(connection.connectionStatus).toBe("INITIATED");
+
+        const connection2 = await connectedAccounts.get({connectedAccountId: connection.connectedAccountId});
+        if(!connection2) throw new Error("Connection not found");
+        expect(connection2.entityId).toBe(entityId);
+    });
 
     it("get connection for github", async () => {
         const app = "github";

js/src/sdk/models/Entity.ts

@@ -247,7 +247,7 @@ export class Entity {
         // Initiate the connection process
         return this.connectedAccounts.initiate({
             integrationId: integration!.id!,
-            userUuid: this.id,
+            entityId: this.id,
             redirectUri: redirectUrl,
             //@ts-ignore
             data: connectionData,

js/src/sdk/models/actions.ts

@@ -41,7 +41,7 @@ export type GetListActionsData = {
     /**
      * Limit of use-cases based search
      */
-    usecaseLimit?: string;
+    usecaseLimit?: number;
     /**
      * Show all actions - i.e disable pagination
      */
@@ -207,6 +207,7 @@ export class Actions {
                     useCase: data.useCase as string,
                     filterImportantActions: data.filterImportantActions,
                     showEnabledOnly: data.showEnabledOnly,
+                    usecaseLimit: data.usecaseLimit || undefined
                 }
             });
             return response.data!;

js/src/sdk/models/connectedAccounts.ts

@@ -9,10 +9,10 @@ type ConnectedAccountsListData = GetConnectionsData['query'] & {appNames?: strin
 
 type InitiateConnectionDataReq = InitiateConnectionPayloadDto & {
     data?: Record<string, unknown> | unknown;
-    userUuid?: string;
     entityId?: string;
     labels?: string[];
     integrationId: string;
+    redirectUri?: string;
 }
 
 export class ConnectedAccounts {
@@ -70,12 +70,13 @@ export class ConnectedAccounts {
 
     async initiate(payload: InitiateConnectionDataReq): Promise<ConnectionRequest> {
         try {
-            const {integrationId, entityId = 'default', labels,data={}} = payload;
+            const {integrationId, entityId = 'default', labels,data={}, redirectUri} = payload;
 
             const res = await client.connections.initiateConnection({ body: {
                 integrationId,
                 entityId,
                 labels,
+                redirectUri,
                 data,
             }  }).then(res => res.data);
 

js/src/sdk/utils/error.ts

@@ -119,8 +119,10 @@ export class CEG {
 
         let axiosDataMessage = axiosError.response?.data?.message || axiosError.message;
         const status = axiosError.response?.status || axiosError.status || axiosError.code || 'unknown';
-        const urlAndStatus = axiosError.config?.url ? `in (URL: ${axiosError.config.url}, Status: ${status})` : '';
-        axiosDataMessage = `${axiosDataMessage || errorDetails.description || "No additional information available."} ${urlAndStatus}`;
+        const request_id = axiosError.response?.headers?.["x-request-id"];
+        const urlAndStatus = axiosError.config?.url ? ` got 📊 ${status} response from URL🔗: ${axiosError.config.url}, request_id: ${request_id}` : '';
+
+        axiosDataMessage = `❌ ${ifObjectStringify(axiosDataMessage) || errorDetails.description || "No additional information available."} ${urlAndStatus}`;
         throw new ComposioError(
             errorKey as string,
             errorDetails.message,
@@ -151,4 +153,8 @@ export class CEG {
 
         throw new ComposioError(messageCode,  message || errorDetails.message, description || errorDetails.description, possibleFix || errorDetails.possibleFix);
     }
+}
+
+export const ifObjectStringify = (obj: any) => {
+    return typeof obj === 'object' ? JSON.stringify(obj) : obj;
 }