Add a complete document resource to the n8n node with 21 operations covering documents, versions, and signatures — matching the MCP specification. Also add the sendSigningNotifications tool to the MCP API for triggering pending signature reminders. n8n operations: create, get, getAll, update, delete, archive, unarchive, getVersion, getAllVersions, createDraftVersion, updateVersion, deleteDraftVersion, publishMajorVersion, publishMinorVersion, requestApproval, voidApproval, getSignature, getAllSignatures, requestSignature, cancelSignature, sendSigningNotifications. Signed-off-by: Sacha Al Himdani <sacha@getprobo.com>
144 lines
4.0 KiB
TypeScript
144 lines
4.0 KiB
TypeScript
// Copyright (c) 2025-2026 Probo Inc <hello@getprobo.com>.
|
|
//
|
|
// Permission to use, copy, modify, and/or distribute this software for any
|
|
// purpose with or without fee is hereby granted, provided that the above
|
|
// copyright notice and this permission notice appear in all copies.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
|
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
|
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
|
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
|
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
|
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
// PERFORMANCE OF THIS SOFTWARE.
|
|
|
|
import type { INodeProperties, IExecuteFunctions, INodeExecutionData } from 'n8n-workflow';
|
|
import { proboApiRequest } from '../../GenericFunctions';
|
|
|
|
export const description: INodeProperties[] = [
|
|
{
|
|
displayName: 'Document Version ID',
|
|
name: 'documentVersionId',
|
|
type: 'string',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['updateVersion'],
|
|
},
|
|
},
|
|
default: '',
|
|
description: 'The ID of the document version to update',
|
|
required: true,
|
|
},
|
|
{
|
|
displayName: 'Update Fields',
|
|
name: 'updateFields',
|
|
type: 'collection',
|
|
placeholder: 'Add Field',
|
|
default: {},
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['updateVersion'],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
displayName: 'Title',
|
|
name: 'title',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'The title of the document version',
|
|
},
|
|
{
|
|
displayName: 'Content',
|
|
name: 'content',
|
|
type: 'string',
|
|
typeOptions: {
|
|
rows: 6,
|
|
},
|
|
default: '',
|
|
description: 'The content of the document in markdown format',
|
|
},
|
|
{
|
|
displayName: 'Classification',
|
|
name: 'classification',
|
|
type: 'options',
|
|
options: [
|
|
{ name: 'Confidential', value: 'CONFIDENTIAL' },
|
|
{ name: 'Internal', value: 'INTERNAL' },
|
|
{ name: 'Public', value: 'PUBLIC' },
|
|
{ name: 'Secret', value: 'SECRET' },
|
|
],
|
|
default: 'INTERNAL',
|
|
description: 'The classification of the document',
|
|
},
|
|
{
|
|
displayName: 'Document Type',
|
|
name: 'documentType',
|
|
type: 'options',
|
|
options: [
|
|
{ name: 'Governance', value: 'GOVERNANCE' },
|
|
{ name: 'Other', value: 'OTHER' },
|
|
{ name: 'Plan', value: 'PLAN' },
|
|
{ name: 'Policy', value: 'POLICY' },
|
|
{ name: 'Procedure', value: 'PROCEDURE' },
|
|
{ name: 'Record', value: 'RECORD' },
|
|
{ name: 'Register', value: 'REGISTER' },
|
|
{ name: 'Report', value: 'REPORT' },
|
|
{ name: 'Template', value: 'TEMPLATE' },
|
|
],
|
|
default: 'POLICY',
|
|
description: 'The type of the document',
|
|
},
|
|
],
|
|
},
|
|
];
|
|
|
|
export async function execute(
|
|
this: IExecuteFunctions,
|
|
itemIndex: number,
|
|
): Promise<INodeExecutionData> {
|
|
const documentVersionId = this.getNodeParameter('documentVersionId', itemIndex) as string;
|
|
const updateFields = this.getNodeParameter('updateFields', itemIndex, {}) as {
|
|
title?: string;
|
|
content?: string;
|
|
classification?: string;
|
|
documentType?: string;
|
|
};
|
|
|
|
const query = `
|
|
mutation UpdateDocumentVersion($input: UpdateDocumentVersionInput!) {
|
|
updateDocumentVersion(input: $input) {
|
|
documentVersion {
|
|
id
|
|
title
|
|
major
|
|
minor
|
|
status
|
|
content
|
|
changelog
|
|
classification
|
|
documentType
|
|
publishedAt
|
|
createdAt
|
|
updatedAt
|
|
}
|
|
}
|
|
}
|
|
`;
|
|
|
|
const input: Record<string, unknown> = { documentVersionId };
|
|
if (updateFields.title !== undefined) input.title = updateFields.title;
|
|
if (updateFields.content !== undefined) input.content = updateFields.content;
|
|
if (updateFields.classification !== undefined) input.classification = updateFields.classification;
|
|
if (updateFields.documentType !== undefined) input.documentType = updateFields.documentType;
|
|
|
|
const responseData = await proboApiRequest.call(this, query, { input });
|
|
|
|
return {
|
|
json: responseData,
|
|
pairedItem: { item: itemIndex },
|
|
};
|
|
}
|