n8n/packages/nodes-base/nodes/Notion/v2/NotionV2.node.ts

import {
	IExecuteFunctions,
} from 'n8n-core';

import {
	ICredentialDataDecryptedObject,
	ICredentialsDecrypted,
	ICredentialTestFunctions,
	IDataObject,
	ILoadOptionsFunctions,
	INodeExecutionData,
	INodePropertyOptions,
	INodeType,
	INodeTypeBaseDescription,
	INodeTypeDescription,
	NodeApiError,
	NodeCredentialTestResult,
} from 'n8n-workflow';

import {
	downloadFiles,
	extractDatabaseId,
	extractPageId,
	formatBlocks,
	formatTitle,
	getBlockTypes,
	mapFilters,
	mapProperties,
	mapSorting,
	notionApiRequest,
	notionApiRequestAllItems,
	simplifyObjects,
	validateCrendetials,
	validateJSON,
} from '../GenericFunctions';

import * as moment from 'moment-timezone';

import {
	versionDescription
} from './VersionDescription';

export class NotionV2 implements INodeType {

	description: INodeTypeDescription;

	constructor(baseDescription: INodeTypeBaseDescription) {
		this.description = {
			...baseDescription,
			...versionDescription,
		};
	}

	methods = {
		loadOptions: {
			async getDatabases(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
				const returnData: INodePropertyOptions[] = [];
				const body: IDataObject = {
					page_size: 100,
					filter: { property: 'object', value: 'database' },
				};
				const databases = await notionApiRequestAllItems.call(this, 'results', 'POST', `/search`, body);
				for (const database of databases) {
					returnData.push({
						name: database.title[0]?.plain_text || database.id,
						value: database.id,
					});
				}
				returnData.sort((a, b) => {
					if (a.name.toLocaleLowerCase() < b.name.toLocaleLowerCase()) { return -1; }
					if (a.name.toLocaleLowerCase() > b.name.toLocaleLowerCase()) { return 1; }
					return 0;
				});
				return returnData;
			},
			async getDatabaseProperties(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
				const returnData: INodePropertyOptions[] = [];
				const databaseId = this.getCurrentNodeParameter('databaseId') as string;
				const { properties } = await notionApiRequest.call(this, 'GET', `/databases/${databaseId}`);
				for (const key of Object.keys(properties)) {
					//remove parameters that cannot be set from the API.
					if (!['created_time', 'last_edited_time', 'created_by', 'last_edited_by', 'formula', 'files', 'rollup'].includes(properties[key].type)) {
						returnData.push({
							name: `${key}`,
							value: `${key}|${properties[key].type}`,
						});
					}
				}
				returnData.sort((a, b) => {
					if (a.name.toLocaleLowerCase() < b.name.toLocaleLowerCase()) { return -1; }
					if (a.name.toLocaleLowerCase() > b.name.toLocaleLowerCase()) { return 1; }
					return 0;
				});
				return returnData;
			},
			async getFilterProperties(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
				const returnData: INodePropertyOptions[] = [];
				const databaseId = this.getCurrentNodeParameter('databaseId') as string;
				const { properties } = await notionApiRequest.call(this, 'GET', `/databases/${databaseId}`);
				for (const key of Object.keys(properties)) {
					returnData.push({
						name: `${key}`,
						value: `${key}|${properties[key].type}`,
					});
				}
				returnData.sort((a, b) => {
					if (a.name.toLocaleLowerCase() < b.name.toLocaleLowerCase()) { return -1; }
					if (a.name.toLocaleLowerCase() > b.name.toLocaleLowerCase()) { return 1; }
					return 0;
				});
				return returnData;
			},
			async getBlockTypes(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
				return getBlockTypes();
			},
			async getPropertySelectValues(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
				const [name, type] = (this.getCurrentNodeParameter('&key') as string).split('|');
				const databaseId = this.getCurrentNodeParameter('databaseId') as string;
				const resource = this.getCurrentNodeParameter('resource') as string;
				const operation = this.getCurrentNodeParameter('operation') as string;
				const { properties } = await notionApiRequest.call(this, 'GET', `/databases/${databaseId}`);
				if (resource === 'databasePage') {
					if (['multi_select', 'select'].includes(type) && operation === 'getAll') {
						return (properties[name][type].options)
							.map((option: IDataObject) => ({ name: option.name, value: option.name }));
					} else if (['multi_select', 'select'].includes(type) && ['create', 'update'].includes(operation)) {
						return (properties[name][type].options)
							.map((option: IDataObject) => ({ name: option.name, value: option.name }));
					}
				}
				return (properties[name][type].options).map((option: IDataObject) => ({ name: option.name, value: option.id }));
			},
			async getUsers(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
				const returnData: INodePropertyOptions[] = [];
				const users = await notionApiRequestAllItems.call(this, 'results', 'GET', '/users');
				for (const user of users) {
					returnData.push({
						name: user.name,
						value: user.id,
					});
				}
				return returnData;
			},
			async getDatabaseIdFromPage(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
				const returnData: INodePropertyOptions[] = [];
				const pageId = extractPageId(this.getCurrentNodeParameter('pageId') as string);
				const { parent: { database_id: databaseId } } = await notionApiRequest.call(this, 'GET', `/pages/${pageId}`);
				const { properties } = await notionApiRequest.call(this, 'GET', `/databases/${databaseId}`);
				for (const key of Object.keys(properties)) {
					//remove parameters that cannot be set from the API.
					if (!['created_time', 'last_edited_time', 'created_by', 'last_edited_by', 'formula', 'files', 'rollup'].includes(properties[key].type)) {
						returnData.push({
							name: `${key}`,
							value: `${key}|${properties[key].type}`,
						});
					}
				}
				returnData.sort((a, b) => {
					if (a.name.toLocaleLowerCase() < b.name.toLocaleLowerCase()) { return -1; }
					if (a.name.toLocaleLowerCase() > b.name.toLocaleLowerCase()) { return 1; }
					return 0;
				});
				return returnData;
			},

			async getDatabaseOptionsFromPage(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
				const pageId = extractPageId(this.getCurrentNodeParameter('pageId') as string);
				const [name, type] = (this.getCurrentNodeParameter('&key') as string).split('|');
				const { parent: { database_id: databaseId } } = await notionApiRequest.call(this, 'GET', `/pages/${pageId}`);
				const { properties } = await notionApiRequest.call(this, 'GET', `/databases/${databaseId}`);
				return (properties[name][type].options).map((option: IDataObject) => ({ name: option.name, value: option.name }));
			},

			// Get all the timezones to display them to user so that he can
			// select them easily
			async getTimezones(
				this: ILoadOptionsFunctions,
			): Promise<INodePropertyOptions[]> {
				const returnData: INodePropertyOptions[] = [];
				for (const timezone of moment.tz.names()) {
					const timezoneName = timezone;
					const timezoneId = timezone;
					returnData.push({
						name: timezoneName,
						value: timezoneId,
					});
				}
				returnData.unshift({
					name: 'Default',
					value: 'default',
					description: 'Timezone set in n8n',
				});
				return returnData;
			},
		},
		credentialTest: {
			async notionApiCredentialTest(this: ICredentialTestFunctions, credential: ICredentialsDecrypted): Promise<NodeCredentialTestResult> {
				try {
					await validateCrendetials.call(this, credential.data as ICredentialDataDecryptedObject);
				} catch (error) {
					return {
						status: 'Error',
						message: 'The security token included in the request is invalid',
					};
				}

				return {
					status: 'OK',
					message: 'Connection successful!',
				};
			},
		},
	};

	async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
		const items = this.getInputData();
		const returnData: IDataObject[] = [];
		const length = items.length as unknown as number;
		let responseData;
		const qs: IDataObject = {};
		const timezone = this.getTimezone();

		const resource = this.getNodeParameter('resource', 0) as string;
		const operation = this.getNodeParameter('operation', 0) as string;
		let download = false;

		if (resource === 'block') {

			if (operation === 'append') {
				for (let i = 0; i < length; i++) {
					const blockId = extractPageId(this.getNodeParameter('blockId', i) as string);
					const body: IDataObject = {
						children: formatBlocks(this.getNodeParameter('blockUi.blockValues', i, []) as IDataObject[]),
					};
					const block = await notionApiRequest.call(this, 'PATCH', `/blocks/${blockId}/children`, body);
					returnData.push(block);
				}
			}

			if (operation === 'getAll') {
				for (let i = 0; i < length; i++) {
					const blockId = extractPageId(this.getNodeParameter('blockId', i) as string);
					const returnAll = this.getNodeParameter('returnAll', i) as boolean;
					if (returnAll) {
						responseData = await notionApiRequestAllItems.call(this, 'results', 'GET', `/blocks/${blockId}/children`, {});
					} else {
						qs.page_size = this.getNodeParameter('limit', i) as number;
						responseData = await notionApiRequest.call(this, 'GET', `/blocks/${blockId}/children`, {}, qs);
						responseData = responseData.results;
					}
					returnData.push.apply(returnData, responseData);
				}
			}
		}

		if (resource === 'database') {

			if (operation === 'get') {
				const simple = this.getNodeParameter('simple', 0) as boolean;
				for (let i = 0; i < length; i++) {
					const databaseId = extractDatabaseId(this.getNodeParameter('databaseId', i) as string);
					responseData = await notionApiRequest.call(this, 'GET', `/databases/${databaseId}`);
					if (simple === true) {
						responseData = simplifyObjects(responseData, download)[0];
					}
					returnData.push(responseData);
				}
			}

			if (operation === 'getAll') {
				const simple = this.getNodeParameter('simple', 0) as boolean;
				for (let i = 0; i < length; i++) {
					const body: IDataObject = {
						filter: { property: 'object', value: 'database' },
					};
					const returnAll = this.getNodeParameter('returnAll', i) as boolean;
					if (returnAll) {
						responseData = await notionApiRequestAllItems.call(this, 'results', 'POST', `/search`, body);
					} else {
						body['page_size'] = this.getNodeParameter('limit', i) as number;
						responseData = await notionApiRequest.call(this, 'POST', `/search`, body);
						responseData = responseData.results;
					}

					if (simple === true) {
						responseData = simplifyObjects(responseData, download);
					}
					returnData.push.apply(returnData, responseData);
				}
			}

			if (operation === 'search') {
				for (let i = 0; i < length; i++) {
					const text = this.getNodeParameter('text', i) as string;
					const options = this.getNodeParameter('options', i) as IDataObject;
					const returnAll = this.getNodeParameter('returnAll', i) as boolean;
					const simple = this.getNodeParameter('simple', i) as boolean;
					const body: IDataObject = {
						filter: {
							property: 'object',
							value: 'database',
						},
					};

					if (text) {
						body['query'] = text;
					}
					if (options.sort) {
						const sort = (options.sort as IDataObject || {}).sortValue as IDataObject || {};
						body['sort'] = sort;
					}
					if (returnAll) {
						responseData = await notionApiRequestAllItems.call(this, 'results', 'POST', '/search', body);
					} else {
						qs.limit = this.getNodeParameter('limit', i) as number;
						responseData = await notionApiRequestAllItems.call(this, 'results', 'POST', '/search', body);
						responseData = responseData.splice(0, qs.limit);
					}

					if (simple === true) {
						responseData = simplifyObjects(responseData, download);
					}

					returnData.push.apply(returnData, responseData);
				}
			}
		}

		if (resource === 'databasePage') {

			if (operation === 'create') {
				const databaseId = this.getNodeParameter('databaseId', 0) as string;
				const { properties } = await notionApiRequest.call(this, 'GET', `/databases/${databaseId}`);
				let titleKey = '';
				for (const key of Object.keys(properties)) {
					if (properties[key].type === 'title') {
						titleKey = key;
					}
				}
				for (let i = 0; i < length; i++) {
					const title = this.getNodeParameter('title', i) as string;
					const simple = this.getNodeParameter('simple', i) as boolean;
					// tslint:disable-next-line: no-any
					const body: { [key: string]: any } = {
						parent: {},
						properties: {},
					};
					if (title !== '') {
						body.properties[titleKey] = {
							title: [
								{
									text: {
										content: title,
									},
								},
							],
						};
					}
					body.parent['database_id'] = this.getNodeParameter('databaseId', i) as string;
					const properties = this.getNodeParameter('propertiesUi.propertyValues', i, []) as IDataObject[];
					if (properties.length !== 0) {
						body.properties = Object.assign(body.properties, mapProperties(properties, timezone, 2) as IDataObject);
					}
					body.children = formatBlocks(this.getNodeParameter('blockUi.blockValues', i, []) as IDataObject[]);
					responseData = await notionApiRequest.call(this, 'POST', '/pages', body);
					if (simple === true) {
						responseData = simplifyObjects(responseData);
					}
					returnData.push.apply(returnData, Array.isArray(responseData) ? responseData : [responseData]);
				}
			}

			if (operation === 'get') {
				for (let i = 0; i < length; i++) {
					const pageId = extractPageId(this.getNodeParameter('pageId', i) as string);
					const simple = this.getNodeParameter('simple', i) as boolean;
					responseData = await notionApiRequest.call(this, 'GET', `/pages/${pageId}`);
					if (simple === true) {
						responseData = simplifyObjects(responseData, download);
					}
					returnData.push.apply(returnData, Array.isArray(responseData) ? responseData : [responseData]);
				}
			}

			if (operation === 'getAll') {
				for (let i = 0; i < length; i++) {
					download = this.getNodeParameter('options.downloadFiles', 0, false) as boolean;
					const simple = this.getNodeParameter('simple', 0) as boolean;
					const databaseId = this.getNodeParameter('databaseId', i) as string;
					const returnAll = this.getNodeParameter('returnAll', i) as boolean;
					const filterType = this.getNodeParameter('filterType', 0) as string;
					const conditions = this.getNodeParameter('filters.conditions', i, []) as IDataObject[];
					const sort = this.getNodeParameter('options.sort.sortValue', i, []) as IDataObject[];
					const body: IDataObject = {
						filter: {},
					};

					if (filterType === 'manual') {
						const matchType = this.getNodeParameter('matchType', 0) as string;
						if (matchType === 'anyFilter') {
							Object.assign(body.filter, { or: conditions.map((data) => mapFilters([data], timezone)) });
						} else if (matchType === 'allFilters') {
							Object.assign(body.filter, { and: conditions.map((data) => mapFilters([data], timezone)) });
						}
					} else if (filterType === 'json') {
						const filterJson = this.getNodeParameter('filterJson', i) as string;
						if (validateJSON(filterJson) !== undefined) {
							body.filter = JSON.parse(filterJson);
						} else {
							throw new NodeApiError(this.getNode(), { message: 'Filters (JSON) must be a valid json' });
						}
					}

					if (!Object.keys(body.filter as IDataObject).length) {
						delete body.filter;
					}
					if (sort) {
						//@ts-expect-error
						body['sorts'] = mapSorting(sort);
					}
					if (returnAll) {
						responseData = await notionApiRequestAllItems.call(this, 'results', 'POST', `/databases/${databaseId}/query`, body, {});
					} else {
						body.page_size = this.getNodeParameter('limit', i) as number;
						responseData = await notionApiRequest.call(this, 'POST', `/databases/${databaseId}/query`, body, qs);
						responseData = responseData.results;
					}
					if (download === true) {
						responseData = await downloadFiles.call(this, responseData);
					}
					if (simple === true) {
						responseData = simplifyObjects(responseData, download);
					}
					returnData.push.apply(returnData, responseData);
				}
			}

			if (operation === 'update') {
				for (let i = 0; i < length; i++) {
					const pageId = extractPageId(this.getNodeParameter('pageId', i) as string);
					const simple = this.getNodeParameter('simple', i) as boolean;
					const properties = this.getNodeParameter('propertiesUi.propertyValues', i, []) as IDataObject[];
					// tslint:disable-next-line: no-any
					const body: { [key: string]: any } = {
						properties: {},
					};
					if (properties.length !== 0) {
						body.properties = mapProperties(properties, timezone, 2) as IDataObject;
					}
					responseData = await notionApiRequest.call(this, 'PATCH', `/pages/${pageId}`, body);
					if (simple === true) {
						responseData = simplifyObjects(responseData, false);
					}
					returnData.push.apply(returnData, Array.isArray(responseData) ? responseData : [responseData]);
				}
			}
		}

		if (resource === 'user') {

			if (operation === 'get') {
				for (let i = 0; i < length; i++) {
					const userId = this.getNodeParameter('userId', i) as string;
					responseData = await notionApiRequest.call(this, 'GET', `/users/${userId}`);
					returnData.push(responseData);
				}
			}
			if (operation === 'getAll') {
				for (let i = 0; i < length; i++) {
					const returnAll = this.getNodeParameter('returnAll', i) as boolean;
					if (returnAll) {
						responseData = await notionApiRequestAllItems.call(this, 'results', 'GET', '/users');
					} else {
						qs.limit = this.getNodeParameter('limit', i) as number;
						responseData = await notionApiRequestAllItems.call(this, 'results', 'GET', '/users');
						responseData = responseData.splice(0, qs.limit);
					}
					returnData.push.apply(returnData, responseData);
				}
			}
		}

		if (resource === 'page') {

			if (operation === 'archive') {
				for (let i = 0; i < length; i++) {
					const pageId = extractPageId(this.getNodeParameter('pageId', i) as string);
					const simple = this.getNodeParameter('simple', i) as boolean;
					responseData = await notionApiRequest.call(this, 'PATCH', `/pages/${pageId}`, { archived: true });
					if (simple === true) {
						responseData = simplifyObjects(responseData, download);
					}
					returnData.push.apply(returnData, Array.isArray(responseData) ? responseData : [responseData]);
				}
			}

			if (operation === 'create') {
				for (let i = 0; i < length; i++) {
					const simple = this.getNodeParameter('simple', i) as boolean;
					// tslint:disable-next-line: no-any
					const body: { [key: string]: any } = {
						parent: {},
						properties: {},
					};
					body.parent['page_id'] = extractPageId(this.getNodeParameter('pageId', i) as string);
					body.properties = formatTitle(this.getNodeParameter('title', i) as string);
					body.children = formatBlocks(this.getNodeParameter('blockUi.blockValues', i, []) as IDataObject[]);
					responseData = await notionApiRequest.call(this, 'POST', '/pages', body);
					if (simple === true) {
						responseData = simplifyObjects(responseData, download);
					}
					returnData.push.apply(returnData, Array.isArray(responseData) ? responseData : [responseData]);
				}
			}

			if (operation === 'search') {
				for (let i = 0; i < length; i++) {
					const text = this.getNodeParameter('text', i) as string;
					const options = this.getNodeParameter('options', i) as IDataObject;
					const returnAll = this.getNodeParameter('returnAll', i) as boolean;
					const simple = this.getNodeParameter('simple', i) as boolean;
					const body: IDataObject = {};

					if (text) {
						body['query'] = text;
					}
					if (options.filter) {
						const filter = (options.filter as IDataObject || {}).filters as IDataObject[] || [];
						body['filter'] = filter;
					}
					if (options.sort) {
						const sort = (options.sort as IDataObject || {}).sortValue as IDataObject || {};
						body['sort'] = sort;
					}
					if (returnAll) {
						responseData = await notionApiRequestAllItems.call(this, 'results', 'POST', '/search', body);
					} else {
						qs.limit = this.getNodeParameter('limit', i) as number;
						responseData = await notionApiRequestAllItems.call(this, 'results', 'POST', '/search', body);
						responseData = responseData.splice(0, qs.limit);
					}

					if (simple === true) {
						responseData = simplifyObjects(responseData, download);
					}

					returnData.push.apply(returnData, responseData);
				}
			}
		}
		if (download === true) {
			return this.prepareOutputData(returnData as INodeExecutionData[]);
		}
		return [this.helpers.returnJsonArray(returnData)];
	}
}