Files
simstudioai--sim/apps/sim/tools/jira/add_watcher.ts
T
wehub-resource-sync d25d482dc2
Publish CLI Package / publish-npm (push) Waiting to run
Publish Python SDK / publish-pypi (push) Waiting to run
Publish TypeScript SDK / publish-npm (push) Waiting to run
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

139 lines
4.3 KiB
TypeScript

import type { JiraAddWatcherParams, JiraAddWatcherResponse } from '@/tools/jira/types'
import { SUCCESS_OUTPUT, TIMESTAMP_OUTPUT } from '@/tools/jira/types'
import { getJiraCloudId } from '@/tools/jira/utils'
import type { ToolConfig } from '@/tools/types'
export const jiraAddWatcherTool: ToolConfig<JiraAddWatcherParams, JiraAddWatcherResponse> = {
id: 'jira_add_watcher',
name: 'Jira Add Watcher',
description: 'Add a watcher to a Jira issue to receive notifications about updates',
version: '1.0.0',
oauth: {
required: true,
provider: 'jira',
},
params: {
accessToken: {
type: 'string',
required: true,
visibility: 'hidden',
description: 'OAuth access token for Jira',
},
domain: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'Your Jira domain (e.g., yourcompany.atlassian.net)',
},
issueKey: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'Jira issue key to add watcher to (e.g., PROJ-123)',
},
accountId: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'Account ID of the user to add as watcher',
},
cloudId: {
type: 'string',
required: false,
visibility: 'hidden',
description:
'Jira Cloud ID for the instance. If not provided, it will be fetched using the domain.',
},
},
request: {
url: (params: JiraAddWatcherParams) => {
if (params.cloudId) {
return `https://api.atlassian.com/ex/jira/${params.cloudId}/rest/api/3/issue/${params.issueKey?.trim() ?? ''}/watchers`
}
return 'https://api.atlassian.com/oauth/token/accessible-resources'
},
method: (params: JiraAddWatcherParams) => (params.cloudId ? 'POST' : 'GET'),
headers: (params: JiraAddWatcherParams) => {
return {
Accept: 'application/json',
'Content-Type': 'application/json',
Authorization: `Bearer ${params.accessToken}`,
}
},
body: (params: JiraAddWatcherParams) => {
if (!params.cloudId) return undefined as any
if (!params.accountId) {
throw new Error('accountId is required to add a Jira watcher')
}
return params.accountId as any
},
},
transformResponse: async (response: Response, params?: JiraAddWatcherParams) => {
if (!params?.accountId) {
throw new Error('accountId is required to add a Jira watcher')
}
if (!params?.cloudId) {
const cloudId = await getJiraCloudId(params!.domain, params!.accessToken)
const watcherUrl = `https://api.atlassian.com/ex/jira/${cloudId}/rest/api/3/issue/${params!.issueKey?.trim() ?? ''}/watchers`
const watcherResponse = await fetch(watcherUrl, {
method: 'POST',
headers: {
Accept: 'application/json',
'Content-Type': 'application/json',
Authorization: `Bearer ${params!.accessToken}`,
},
body: JSON.stringify(params!.accountId),
})
if (!watcherResponse.ok) {
let message = `Failed to add watcher to Jira issue (${watcherResponse.status})`
try {
const err = await watcherResponse.json()
message = err?.errorMessages?.join(', ') || err?.message || message
} catch (_e) {}
throw new Error(message)
}
return {
success: true,
output: {
ts: new Date().toISOString(),
issueKey: params!.issueKey || 'unknown',
watcherAccountId: params!.accountId || 'unknown',
success: true,
},
}
}
if (!response.ok) {
let message = `Failed to add watcher to Jira issue (${response.status})`
try {
const err = await response.json()
message = err?.errorMessages?.join(', ') || err?.message || message
} catch (_e) {}
throw new Error(message)
}
return {
success: true,
output: {
ts: new Date().toISOString(),
issueKey: params!.issueKey || 'unknown',
watcherAccountId: params!.accountId || 'unknown',
success: true,
},
}
},
outputs: {
ts: TIMESTAMP_OUTPUT,
success: SUCCESS_OUTPUT,
issueKey: { type: 'string', description: 'Issue key' },
watcherAccountId: { type: 'string', description: 'Added watcher account ID' },
},
}