Files
simstudioai--sim/apps/sim/tools/microsoft_dataverse/disassociate.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

128 lines
4.2 KiB
TypeScript

import { createLogger } from '@sim/logger'
import type {
DataverseDisassociateParams,
DataverseDisassociateResponse,
} from '@/tools/microsoft_dataverse/types'
import { getDataverseBaseUrl } from '@/tools/microsoft_dataverse/utils'
import type { ToolConfig } from '@/tools/types'
const logger = createLogger('DataverseDisassociate')
export const dataverseDisassociateTool: ToolConfig<
DataverseDisassociateParams,
DataverseDisassociateResponse
> = {
id: 'microsoft_dataverse_disassociate',
name: 'Disassociate Microsoft Dataverse Records',
description:
'Remove an association between two records in Microsoft Dataverse. For collection-valued navigation properties, provide the target record ID. For single-valued navigation properties, only the navigation property name is needed.',
version: '1.0.0',
oauth: { required: true, provider: 'microsoft-dataverse' },
errorExtractor: 'nested-error-object',
params: {
accessToken: {
type: 'string',
required: true,
visibility: 'hidden',
description: 'OAuth access token for Microsoft Dataverse API',
},
environmentUrl: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'Dataverse environment URL (e.g., https://myorg.crm.dynamics.com)',
},
entitySetName: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'Source entity set name (e.g., accounts)',
},
recordId: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'Source record GUID',
},
navigationProperty: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description:
'Navigation property name (e.g., contact_customer_accounts for collection-valued, or parentcustomerid_account for single-valued)',
},
targetRecordId: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description:
'Target record GUID (required for collection-valued navigation properties, omit for single-valued)',
},
},
request: {
url: (params) => {
const baseUrl = getDataverseBaseUrl(params.environmentUrl)
const entitySetName = params.entitySetName.trim()
const recordId = params.recordId.trim()
const navigationProperty = params.navigationProperty.trim()
if (params.targetRecordId) {
return `${baseUrl}/api/data/v9.2/${entitySetName}(${recordId})/${navigationProperty}(${params.targetRecordId.trim()})/$ref`
}
return `${baseUrl}/api/data/v9.2/${entitySetName}(${recordId})/${navigationProperty}/$ref`
},
method: 'DELETE',
headers: (params) => ({
Authorization: `Bearer ${params.accessToken}`,
'OData-MaxVersion': '4.0',
'OData-Version': '4.0',
Accept: 'application/json',
}),
},
transformResponse: async (response: Response, params?: DataverseDisassociateParams) => {
if (!response.ok) {
const errorData = await response.json().catch(() => ({}))
const errorMessage =
errorData?.error?.message ??
`Dataverse API error: ${response.status} ${response.statusText}`
logger.error('Dataverse disassociate failed', { errorData, status: response.status })
throw new Error(errorMessage)
}
return {
success: true,
output: {
success: true,
entitySetName: params?.entitySetName ?? '',
recordId: params?.recordId ?? '',
navigationProperty: params?.navigationProperty ?? '',
...(params?.targetRecordId ? { targetRecordId: params.targetRecordId } : {}),
},
}
},
outputs: {
success: {
type: 'boolean',
description: 'Whether the disassociation was completed successfully',
},
entitySetName: {
type: 'string',
description: 'Source entity set name used in the disassociation',
},
recordId: { type: 'string', description: 'Source record GUID that was disassociated' },
navigationProperty: {
type: 'string',
description: 'Navigation property used for the disassociation',
},
targetRecordId: {
type: 'string',
description: 'Target record GUID that was disassociated',
optional: true,
},
},
}