fix(windchill): align tool contracts and docs

Author: Bill Leoutsakos

apps/docs/content/docs/en/integrations/windchill.mdx

@@ -311,6 +311,43 @@ describe('POST /api/tools/windchill', () => {
     })
   })
 
+  it('returns operation-specific single, bulk, and delete mutation shapes', async () => {
+    const singleResponse = await POST(
+      createMockRequest('POST', {
+        ...BASE_BODY,
+        operation: 'windchill_update_document',
+        documentOid: DOCUMENT_OID,
+        attributes: { Title: 'Updated' },
+      })
+    )
+    const singleOutput = (await singleResponse.json()).output
+    expect(singleOutput.document).toMatchObject({ id: DOCUMENT_OID })
+    expect(singleOutput).not.toHaveProperty('documents')
+
+    const bulkResponse = await POST(
+      createMockRequest('POST', {
+        ...BASE_BODY,
+        operation: 'windchill_update_documents',
+        documents: [{ id: DOCUMENT_OID, attributes: { Title: 'Updated' } }],
+      })
+    )
+    const bulkOutput = (await bulkResponse.json()).output
+    expect(bulkOutput.documents).toEqual([expect.objectContaining({ id: DOCUMENT_OID })])
+    expect(bulkOutput).not.toHaveProperty('document')
+
+    const deleteResponse = await POST(
+      createMockRequest('POST', {
+        ...BASE_BODY,
+        operation: 'windchill_delete_document',
+        documentOid: DOCUMENT_OID,
+      })
+    )
+    const deleteOutput = (await deleteResponse.json()).output
+    expect(deleteOutput.affectedIds).toEqual([DOCUMENT_OID])
+    expect(deleteOutput).not.toHaveProperty('document')
+    expect(deleteOutput).not.toHaveProperty('documents')
+  })
+
   it('authorizes and reads a UserFile before starting the upload transaction', async () => {
     const response = await POST(
       createMockRequest('POST', {

apps/sim/app/api/tools/windchill/route.test.ts

@@ -45,6 +45,21 @@ const logger = createLogger('WindchillAPI')
 
 type WindchillRouteOutput = Extract<WindchillOperationResponse, { success: true }>['output']
 
+const BULK_RESULT_OPERATIONS: ReadonlySet<WindchillRouteOutput['operation']> = new Set([
+  'windchill_create_documents',
+  'windchill_update_documents',
+  'windchill_check_out_documents',
+  'windchill_check_in_documents',
+  'windchill_undo_check_out_documents',
+  'windchill_revise_documents',
+  'windchill_update_document_security_labels',
+])
+
+const DELETE_OPERATIONS: ReadonlySet<WindchillRouteOutput['operation']> = new Set([
+  'windchill_delete_document',
+  'windchill_delete_documents',
+])
+
 function successResponse(output: WindchillRouteOutput) {
   const body = { success: true, output } satisfies WindchillOperationResponse
   return NextResponse.json(body)
@@ -82,11 +97,18 @@ function mutationOutput(
       ? [document.id, ...collectionIds]
       : collectionIds
   const affectedIds = returnedIds.length > 0 ? returnedIds : fallbackIds
+  if (DELETE_OPERATIONS.has(operation)) return { operation, affectedIds: fallbackIds }
+  if (BULK_RESULT_OPERATIONS.has(operation)) {
+    return {
+      operation,
+      affectedIds,
+      ...(documents.length > 0 ? { documents } : {}),
+    }
+  }
   return {
     operation,
     affectedIds,
     ...(document ? { document } : {}),
-    ...(documents.length > 0 ? { documents } : {}),
   }
 }