Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
TypeScript agentic-aiagentsaiai-agentsaiagentsdeveloper-toolsfunction-callinggpt-4javascriptjsllmllmopsmcppythonremote-mcp-serverssetypescript
Fix Add support for userid in trigger creation (#1648)
Musthaq Ahamad28b09d6eebad
diff --git a/pnpm-lock.yaml b/pnpm-lock.yamlindex 8a0178c9e..09a97909b 100644--- a/pnpm-lock.yaml+++ b/pnpm-lock.yaml@@ -451,8 +451,8 @@ importers:ts/packages/core:dependencies:'@composio/client':- specifier: 0.1.0-alpha.22- version: 0.1.0-alpha.22+ specifier: 0.1.0-alpha.23+ version: 0.1.0-alpha.23'@composio/json-schema-to-zod':specifier: 0.1.9version: 0.1.9@@ -925,6 +925,9 @@ packages:'@composio/[email protected]':resolution: {integrity: sha512-b9KCO5gy0EsCG+nXikOdm17PiZZ85rw3vwu9aNRIse9rEj2FA1SScpP+P9GN4G0lQHl+QPyDuVvGa6U9AATFeg==}+ '@composio/[email protected]':+ resolution: {integrity: sha512-zDbOJZVR+Ug0a622mjMGsREELKOG6DLF3qKI7qJ9FLP/GpAT7xekyEE7DR0g37zs6ytCy0oV/KMi+KaxxNp+zA==}+'@composio/[email protected]':resolution: {integrity: sha512-ehu0OdwAgjShWjRaXBVlFnaqykDj6rxWcH3GeE179luNqLIb1p0L+Nazb1IMJ1CFl+DQC/NWkI80K8lgRLBQNQ==}@@ -5870,6 +5873,8 @@ snapshots:'@composio/[email protected]': {}+ '@composio/[email protected]': {}+'@composio/[email protected]([email protected])':dependencies:'@composio/client': 0.1.0-alpha.22@@ -7915,6 +7920,14 @@ snapshots:chai: 5.2.0tinyrainbow: 2.0.0+ '@vitest/[email protected]([email protected](@types/[email protected])([email protected])([email protected])([email protected]))':+ dependencies:+ '@vitest/spy': 3.2.3+ estree-walker: 3.0.3+ magic-string: 0.30.17+ optionalDependencies:+'@vitest/[email protected]([email protected](@types/[email protected])([email protected])([email protected])([email protected]))':dependencies:'@vitest/spy': 3.2.3@@ -7923,6 +7936,14 @@ snapshots:optionalDependencies:+ '@vitest/[email protected]([email protected](@types/[email protected])([email protected])([email protected])([email protected]))':+ dependencies:+ '@vitest/spy': 3.2.3+ estree-walker: 3.0.3+ magic-string: 0.30.17+ optionalDependencies:+'@vitest/[email protected]':dependencies:tinyrainbow: 2.0.0@@ -7952,7 +7973,7 @@ snapshots:sirv: 3.0.1tinyglobby: 0.2.14tinyrainbow: 2.0.0- vitest: 3.2.3(@types/[email protected])(@vitest/[email protected])([email protected])([email protected])([email protected])+ vitest: 3.2.3(@types/[email protected])(@vitest/[email protected])([email protected])([email protected])([email protected])'@vitest/[email protected]':dependencies:@@ -10540,7 +10561,7 @@ snapshots:dependencies:'@types/chai': 5.2.2'@vitest/expect': 3.2.3- '@vitest/mocker': 3.2.3([email protected](@types/[email protected])([email protected])([email protected])([email protected]))+ '@vitest/mocker': 3.2.3([email protected](@types/[email protected])([email protected])([email protected])([email protected]))'@vitest/pretty-format': 3.2.3'@vitest/runner': 3.2.3'@vitest/snapshot': 3.2.3@@ -10624,7 +10645,7 @@ snapshots:dependencies:'@types/chai': 5.2.2'@vitest/expect': 3.2.3- '@vitest/mocker': 3.2.3([email protected](@types/[email protected])([email protected])([email protected])([email protected]))+ '@vitest/mocker': 3.2.3([email protected](@types/[email protected])([email protected])([email protected])([email protected]))'@vitest/pretty-format': 3.2.3'@vitest/runner': 3.2.3'@vitest/snapshot': 3.2.3diff --git a/ts/docs/api/triggers.md b/ts/docs/api/triggers.mdindex 4a75bd08a..92452e63a 100644--- a/ts/docs/api/triggers.md+++ b/ts/docs/api/triggers.md@@ -33,17 +33,91 @@ const triggers = await composio.triggers.listActive({### Create Trigger Instance-Create a new trigger instance for a specific trigger type:+Create a new trigger instance for a specific user and trigger type. If a connected account ID is not provided, the SDK will automatically use the first available connected account for the user and toolkit.++**With Connected Account ID:**```typescript-const trigger = await composio.triggers.create('trigger-slug', {- connectedAccountId: 'connected-account-id',+const trigger = await composio.triggers.create('default', 'GMAIL_NEW_GMAIL_MESSAGE', {+ connectedAccountId: 'ca_jjYIG9L40LDIS', // Specify which connected account to usetriggerConfig: {- // Trigger specific configuration+ labelIds: 'INBOX',+ userId: 'me',+ interval: 60,},});```+**Without Connected Account ID (Using First Available):**++```typescript+const trigger = await composio.triggers.create('default', 'GMAIL_NEW_GMAIL_MESSAGE', {+ triggerConfig: {+ labelIds: 'INBOX',+ userId: 'me',+ interval: 60,+ },+}); // Will use the first available connected account+```++> **Note:** It's recommended to provide a `connectedAccountId` when you have multiple connected accounts for the same toolkit to ensure the trigger is created for the intended account. If not provided, the SDK will use the first available connected account and log a warning.++**Parameters:**++- `userId` (string, required): The ID of the user to create the trigger instance for+- `slug` (string, required): The slug of the trigger type to create+- `body` (TriggerInstanceUpsertParams, optional): Configuration for the trigger instance+ - `connectedAccountId` (string, optional): ID of the connected account to use. If not provided, will use the first available connected account for the user and toolkit+ - `triggerConfig` (object, optional): Trigger-specific configuration parameters++**Returns:** Promise<TriggerInstanceUpsertResponse> - The created trigger instance with the following structure:++```typescript+{+ triggerId: string; // The ID of the created trigger instance+}+```++**Throws:**++- `ValidationError`: If the provided parameters are invalid+- `ComposioTriggerTypeNotFoundError`: If the trigger type with the given slug is not found+- `ComposioConnectedAccountNotFoundError`: If no connected account is found for the user, or if the specified connected account ID is not found++**Example with Error Handling:**++```typescript+try {+ const trigger = await composio.triggers.create('default', 'GMAIL_NEW_GMAIL_MESSAGE', {+ // Connected account ID is optional - if not provided, will use first available+ connectedAccountId: 'ca_jjYIG9L40LDIS',+ triggerConfig: {+ labelIds: 'INBOX',+ userId: 'me',+ interval: 60,+ },+ });+ console.log('Trigger created:', trigger.triggerId);+} catch (error) {+ if (error instanceof ComposioTriggerTypeNotFoundError) {+ console.error('Trigger type not found:', error.message);+ // Handle invalid trigger type+ } else if (error instanceof ComposioConnectedAccountNotFoundError) {+ console.error('Connected account issue:', error.message);+ // Handle missing or invalid connected account+ // This can happen if:+ // 1. No connected accounts exist for the user and toolkit+ // 2. The specified connectedAccountId was not found+ } else if (error instanceof ValidationError) {+ console.error('Invalid parameters:', error.message);+ // Handle validation errors+ } else {+ console.error('Unexpected error:', error);+ // Handle other errors+ }+}+```+### Update Trigger InstanceUpdate an existing trigger instance:diff --git a/ts/examples/triggers/src/create.ts b/ts/examples/triggers/src/create.tsnew file mode 100644index 000000000..ac7b7e214--- /dev/null+++ b/ts/examples/triggers/src/create.ts@@ -0,0 +1,22 @@+import { Composio } from '@composio/core';++const composio = new Composio({+ apiKey: process.env.COMPOSIO_API_KEY,+});++// fetch a trigger type+const triggerType = await composio.triggers.getType('GMAIL_NEW_GMAIL_MESSAGE');++console.log(JSON.stringify(triggerType, null, 2));++// create a trigger+const trigger = await composio.triggers.create('default', triggerType.slug, {+ connectedAccountId: 'ca_jjYIG9L40LDIS',+ triggerConfig: {+ labelIds: 'INBOX',+ userId: 'me',+ interval: 60,+ },+});++console.log(trigger);diff --git a/ts/packages/core/package.json b/ts/packages/core/package.jsonindex a53355cfd..717663b7d 100644--- a/ts/packages/core/package.json+++ b/ts/packages/core/package.json@@ -37,7 +37,7 @@"vitest": "^3.1.4"},"dependencies": {- "@composio/client": "0.1.0-alpha.22",+ "@composio/client": "0.1.0-alpha.23","@composio/json-schema-to-zod": "0.1.9","chalk": "^5.4.1","openai": "^4.94.0",diff --git a/ts/packages/core/src/errors/TriggerErrors.ts b/ts/packages/core/src/errors/TriggerErrors.tsindex ec457d845..3d6f3dda6 100644--- a/ts/packages/core/src/errors/TriggerErrors.ts+++ b/ts/packages/core/src/errors/TriggerErrors.ts@@ -1,4 +1,5 @@import { ComposioError } from '@composio/client';+import { ComposioErrorOptions } from './ComposioError';export const TriggerErrorCodes = {TRIGGER_FAILED_TO_GET_SDK_REALTIME_CREDENTIALS: 'TRIGGER_FAILED_TO_GET_SDK_REALTIME_CREDENTIALS',@@ -6,6 +7,7 @@ export const TriggerErrorCodes = {TRIGGER_FAILED_TO_SUBSCRIBE_TO_PUSHER_CHANNEL: 'TRIGGER_FAILED_TO_SUBSCRIBE_TO_PUSHER_CHANNEL',TRIGGER_FAILED_TO_UNSUBSCRIBE_FROM_PUSHER_CHANNEL:'TRIGGER_FAILED_TO_UNSUBSCRIBE_FROM_PUSHER_CHANNEL',+ TRIGGER_TYPE_NOT_FOUND: 'TRIGGER_TYPE_NOT_FOUND',} as const;export class ComposioFailedToGetSDKRealtimeCredentialsError extends ComposioError {@@ -14,7 +16,7 @@ export class ComposioFailedToGetSDKRealtimeCredentialsError extends ComposioErropublic statusCode = 500;public possibleFixes = ['Please contact support.'];- constructor(message: string, options?: ErrorOptions) {+ constructor(message: string, options?: ComposioErrorOptions) {super(message, options);}}@@ -25,7 +27,7 @@ export class ComposioFailedToCreatePusherClientError extends ComposioError {public statusCode = 500;public possibleFixes = ['Please contact support.'];- constructor(message: string, options?: ErrorOptions) {+ constructor(message: string, options?: ComposioErrorOptions) {super(message, options);}}@@ -36,7 +38,7 @@ export class ComposioFailedToSubscribeToPusherChannelError extends ComposioErrorpublic statusCode = 500;public possibleFixes = ['Please contact support.'];- constructor(message: string, options?: ErrorOptions) {+ constructor(message: string, options?: ComposioErrorOptions) {super(message, options);}}@@ -47,7 +49,18 @@ export class ComposioFailedToUnsubscribeFromPusherChannelError extends ComposioEpublic statusCode = 500;public possibleFixes = ['Please contact support.'];- constructor(message: string, options?: ErrorOptions) {+ constructor(message: string, options?: ComposioErrorOptions) {+ super(message, options);+ }+}++export class ComposioTriggerTypeNotFoundError extends ComposioError {+ public name = 'ComposioTriggerTypeNotFoundError';+ public code = TriggerErrorCodes.TRIGGER_TYPE_NOT_FOUND;+ public statusCode = 404;+ public possibleFixes = ['Please contact support.'];++ constructor(message: string = 'Trigger type not found', options?: ComposioErrorOptions) {super(message, options);}}diff --git a/ts/packages/core/src/models/Triggers.ts b/ts/packages/core/src/models/Triggers.tsindex 9327a47df..282ef333a 100644--- a/ts/packages/core/src/models/Triggers.ts+++ b/ts/packages/core/src/models/Triggers.ts@@ -1,4 +1,4 @@-import ComposioClient from '@composio/client';+import ComposioClient, { APIError } from '@composio/client';import {TriggerInstanceListActiveResponse as TriggerInstanceListActiveResponseComposio,TriggersTypeListParams,@@ -28,8 +28,9 @@ import {} from '../types/triggers.types';import logger from '../utils/logger';import { telemetry } from '../telemetry/Telemetry';-import { ValidationError } from '../errors';+import { ComposioConnectedAccountNotFoundError, ValidationError } from '../errors';import { PusherService } from '../services/pusher/Pusher';+import { ComposioTriggerTypeNotFoundError } from '../errors/TriggerErrors';/*** Trigger (Instance) class* /api/v3/trigger_instances@@ -133,17 +134,20 @@ export class Triggers {}/**- * Create a new trigger instance+ * Create a new trigger instance for a user+ * If the connected account id is not provided, the first connected account for the user and toolkit will be used*+ * @param {string} userId - The user id of the trigger instance* @param {string} slug - The slug of the trigger instance* @param {TriggerInstanceUpsertParams} body - The parameters to create the trigger instance* @returns {Promise<TriggerInstanceUpsertResponse>} The created trigger instance*/async create(+ userId: string,slug: string,- body: TriggerInstanceUpsertParams+ body?: TriggerInstanceUpsertParams): Promise<TriggerInstanceUpsertResponse> {- const parsedBody = TriggerInstanceUpsertParamsSchema.safeParse(body);+ const parsedBody = TriggerInstanceUpsertParamsSchema.safeParse(body ?? {});if (!parsedBody.success) {throw new ValidationError(`Invalid parameters passed to create trigger`, {@@ -151,10 +155,88 @@ export class Triggers {});}+ // Get the connected account id from the user id+ let triggerType: TriggersTypeRetrieveResponse;+ let toolkitSlug: string;+ try {+ triggerType = await this.getType(slug);+ toolkitSlug = triggerType.toolkit.slug;+ } catch (error) {+ // for some reason, the triggers types list endpoint returns 400 for invalid user ids+ if (error instanceof APIError && (error.status === 400 || error.status === 404)) {+ throw new ComposioTriggerTypeNotFoundError(`Trigger type ${slug} not found`, {+ cause: error,+ possibleFixes: [+ `Please check the trigger slug`,+ `Visit the toolkit page to see the available triggers`,+ ],+ });+ } else {+ throw error;+ }+ }++ // Attempt to get connected account ID+ let connectedAccountId: string | undefined = body?.connectedAccountId;++ try {+ const { items: connectedAccounts } = await this.client.connectedAccounts.list({+ user_ids: [userId],+ toolkit_slugs: [toolkitSlug],+ });++ if (connectedAccounts.length === 0) {+ throw new ComposioConnectedAccountNotFoundError(+ `No connected account found for user ${userId} for toolkit ${toolkitSlug}`,+ {+ cause: new Error(`No connected account found for user ${userId}`),+ possibleFixes: [`Create a new connected account for user ${userId}`],+ }+ );+ }++ const accountExists = connectedAccounts.some(acc => acc.id === connectedAccountId);+ // if the connected account id is provided and it does not exist, throw an error+ if (connectedAccountId && !accountExists) {+ throw new ComposioConnectedAccountNotFoundError(+ `Connected account ID ${connectedAccountId} not found for user ${userId}`,+ {+ cause: new Error(+ `Connected account ID ${connectedAccountId} not found for user ${userId}`+ ),+ possibleFixes: [+ `Create a new connected account for user ${userId}`,+ `Verify the connected account ID`,+ ],+ }+ );+ }++ // if the connected account id is not provided, use the first connected account+ if (!connectedAccountId) {+ connectedAccountId = connectedAccounts[0].id;+ logger.warn(+ `[Warn] Multiple connected accounts found for user ${userId}, using the first one. Pass connectedAccountId to select a specific account.`+ );+ }+ } catch (error) {+ if (error instanceof APIError && [400, 404].includes(error.status)) {+ throw new ComposioConnectedAccountNotFoundError(+ `No connected account found for user ${userId} for toolkit ${toolkitSlug}`,+ {+ cause: error,+ possibleFixes: [`Create a new connected account for user ${userId}`],+ }+ );+ }+ throw error;+ }+const result = await this.client.triggerInstances.upsert(slug, {- connected_account_id: parsedBody.data.connectedAccountId,+ connected_account_id: connectedAccountId,trigger_config: parsedBody.data.triggerConfig,});+const parsedResult = TriggerInstanceUpsertResponseSchema.safeParse({triggerId: result.trigger_id,} as TriggerInstanceUpsertResponse);diff --git a/ts/packages/core/src/types/connectedAccounts.types.ts b/ts/packages/core/src/types/connectedAccounts.types.tsindex 788165bd7..0dc49e6cc 100644--- a/ts/packages/core/src/types/connectedAccounts.types.ts+++ b/ts/packages/core/src/types/connectedAccounts.types.ts@@ -10,6 +10,7 @@ export const ConnectedAccountStatuses = {ACTIVE: 'ACTIVE',FAILED: 'FAILED',EXPIRED: 'EXPIRED',+ INACTIVE: 'INACTIVE',} as const;export const ConnectedAccountStatusSchema = z.enum([ConnectedAccountStatuses.INITIALIZING,diff --git a/ts/packages/core/test/models/triggers.test.ts b/ts/packages/core/test/models/triggers.test.tsindex 713a870f3..d5141ceee 100644--- a/ts/packages/core/test/models/triggers.test.ts+++ b/ts/packages/core/test/models/triggers.test.ts@@ -1,6 +1,6 @@import { describe, it, expect, vi, beforeEach, afterEach, Mock } from 'vitest';import { Triggers } from '../../src/models/Triggers';-import ComposioClient from '@composio/client';+import ComposioClient, { APIError } from '@composio/client';import logger from '../../src/utils/logger';import {TriggerSubscribeParams,@@ -9,9 +9,12 @@ import {IncomingTriggerPayloadSchema,} from '../../src/types/triggers.types';import { telemetry } from '../../src/telemetry/Telemetry';-import { ValidationError } from '../../src/errors';+import { ComposioConnectedAccountNotFoundError, ValidationError } from '../../src/errors';import { PusherService } from '../../src/services/pusher/Pusher';-import { ComposioFailedToSubscribeToPusherChannelError } from '../../src/errors/TriggerErrors';+import {+ ComposioFailedToSubscribeToPusherChannelError,+ ComposioTriggerTypeNotFoundError,+} from '../../src/errors/TriggerErrors';// Mock dependenciesvi.mock('../../src/utils/logger');@@ -39,6 +42,9 @@ const createMockClient = () => ({retrieve: vi.fn(),retrieveEnum: vi.fn(),},+ connectedAccounts: {+ list: vi.fn(),+ },});// Mock response data@@ -107,6 +113,9 @@ const mockTriggerType = {required: ['webhook_url'],optional: ['secret'],},+ toolkit: {+ slug: 'github',+ },};const mockTriggerEnum = {@@ -270,22 +279,123 @@ describe('Triggers', () => {});describe('create', () => {- it('should create a new trigger instance', async () => {- const slug = 'github_webhook';- const body = {- connectedAccountId: 'conn-123',- triggerConfig: { webhook_url: 'https://example.com/webhook' },- };+ const userId = 'user-123';+ const slug = 'github_webhook';+ const body = {+ connectedAccountId: 'conn-123',+ triggerConfig: { webhook_url: 'https://example.com/webhook' },+ };++ beforeEach(() => {+ mockClient.triggersTypes.retrieve.mockResolvedValue(mockTriggerType);mockClient.triggerInstances.upsert.mockResolvedValue(mockTriggerUpsertResponse);+ });- const result = await triggers.create(slug, body);+ it('should create a new trigger instance with provided connected account ID', async () => {+ mockClient.connectedAccounts.list.mockResolvedValue({+ items: [{ id: 'conn-123' }],+ });++ const result = await triggers.create(userId, slug, body);+ expect(mockClient.triggersTypes.retrieve).toHaveBeenCalledWith(slug);+ expect(mockClient.connectedAccounts.list).toHaveBeenCalledWith({+ user_ids: [userId],+ toolkit_slugs: [mockTriggerType.toolkit.slug],+ });expect(mockClient.triggerInstances.upsert).toHaveBeenCalledWith(slug, {connected_account_id: body.connectedAccountId,trigger_config: body.triggerConfig,});expect(result).toEqual({ triggerId: mockTriggerUpsertResponse.trigger_id });});++ it('should use first connected account if no connected account ID is provided', async () => {+ const bodyWithoutConnectedAccount = {+ triggerConfig: body.triggerConfig,+ };+ mockClient.connectedAccounts.list.mockResolvedValue({+ items: [{ id: 'conn-456' }, { id: 'conn-789' }],+ });++ const result = await triggers.create(userId, slug, bodyWithoutConnectedAccount);++ expect(mockClient.triggerInstances.upsert).toHaveBeenCalledWith(slug, {+ connected_account_id: 'conn-456',+ trigger_config: bodyWithoutConnectedAccount.triggerConfig,+ });+ expect(logger.warn).toHaveBeenCalledWith(+ `[Warn] Multiple connected accounts found for user ${userId}, using the first one. Pass connectedAccountId to select a specific account.`+ );+ expect(result).toEqual({ triggerId: mockTriggerUpsertResponse.trigger_id });+ });++ it('should throw validation error for invalid body parameters', async () => {+ const invalidBody = {+ connectedAccountId: 123, // should be string+ triggerConfig: null,+ };++ await expect(triggers.create(userId, slug, invalidBody as any)).rejects.toThrow(+ ValidationError+ );+ expect(mockClient.triggerInstances.upsert).not.toHaveBeenCalled();+ });++ it('should throw error when trigger type is not found', async () => {+ mockClient.triggersTypes.retrieve.mockRejectedValue(+ new APIError(400, 'Trigger type not found', 'Trigger type not found', new Headers())+ );++ await expect(triggers.create(userId, slug, body)).rejects.toThrow(+ ComposioTriggerTypeNotFoundError+ );+ expect(mockClient.triggerInstances.upsert).not.toHaveBeenCalled();+ });++ it('should throw error when no connected accounts are found', async () => {+ mockClient.connectedAccounts.list.mockResolvedValue({+ items: [],+ });++ await expect(triggers.create(userId, slug, body)).rejects.toThrow(+ 'No connected account found for user user-123'+ );+ expect(mockClient.triggerInstances.upsert).not.toHaveBeenCalled();+ });++ it('should throw error when provided connected account ID is not found', async () => {+ mockClient.connectedAccounts.list.mockResolvedValue({+ items: [{ id: 'conn-456' }],+ });++ await expect(triggers.create(userId, slug, body)).rejects.toThrow(+ 'Connected account ID conn-123 not found for user user-123'+ );+ expect(mockClient.triggerInstances.upsert).not.toHaveBeenCalled();+ });++ it('should throw error when connected accounts list request fails', async () => {+ mockClient.connectedAccounts.list.mockRejectedValue(+ new APIError(404, 'Not Connected Account', 'Not Connected Account', new Headers())+ );++ await expect(triggers.create(userId, slug, body)).rejects.toThrow(+ ComposioConnectedAccountNotFoundError+ );+ expect(mockClient.triggerInstances.upsert).not.toHaveBeenCalled();+ });++ it('should throw validation error for invalid upsert response', async () => {+ mockClient.connectedAccounts.list.mockResolvedValue({+ items: [{ id: 'conn-123' }],+ });+ mockClient.triggerInstances.upsert.mockResolvedValue({+ invalid_field: 'value',+ });++ await expect(triggers.create(userId, slug, body)).rejects.toThrow(ValidationError);+ });});describe('update', () => {