first commit

packages/nodes-base/nodes/Google/Drive/v2/actions/fileFolder/FileFolder.resource.ts

@@ -0,0 +1,29 @@
+import type { INodeProperties } from 'n8n-workflow';
+
+import * as search from './search.operation';
+
+export { search };
+
+export const description: INodeProperties[] = [
+	{
+		displayName: 'Operation',
+		name: 'operation',
+		type: 'options',
+		noDataExpression: true,
+		displayOptions: {
+			show: {
+				resource: ['fileFolder'],
+			},
+		},
+		options: [
+			{
+				name: 'Search',
+				value: 'search',
+				description: 'Search or list files and folders',
+				action: 'Search files and folders',
+			},
+		],
+		default: 'search',
+	},
+	...search.description,
+];

packages/nodes-base/nodes/Google/Drive/v2/actions/fileFolder/search.operation.ts

@@ -0,0 +1,364 @@
+import type {
+	IDataObject,
+	IExecuteFunctions,
+	INodeExecutionData,
+	INodeProperties,
+} from 'n8n-workflow';
+
+import { updateDisplayOptions } from '@utils/utilities';
+
+import type { SearchFilter } from '../../helpers/interfaces';
+import { DRIVE, RLC_FOLDER_DEFAULT } from '../../helpers/interfaces';
+import { prepareQueryString, updateDriveScopes } from '../../helpers/utils';
+import { googleApiRequest, googleApiRequestAllItems } from '../../transport';
+import { driveRLC, fileTypesOptions, folderRLC } from '../common.descriptions';
+
+const properties: INodeProperties[] = [
+	{
+		displayName: 'Search Method',
+		name: 'searchMethod',
+		type: 'options',
+		options: [
+			{
+				name: 'Search File/Folder Name',
+				value: 'name',
+			},
+			{
+				name: 'Advanced Search',
+				value: 'query',
+			},
+		],
+		default: 'name',
+		description: 'Whether to search for the file/folder name or use a query string',
+	},
+	{
+		displayName: 'Search Query',
+		name: 'queryString',
+		type: 'string',
+		default: '',
+		displayOptions: {
+			show: {
+				searchMethod: ['name'],
+			},
+		},
+		placeholder: 'e.g. My File / My Folder',
+		description:
+			'The name of the file or folder to search for. Returns also files and folders whose names partially match this search term.',
+	},
+	{
+		displayName: 'Query String',
+		name: 'queryString',
+		type: 'string',
+		default: '',
+		displayOptions: {
+			show: {
+				searchMethod: ['query'],
+			},
+		},
+		placeholder: "e.g. not name contains 'hello'",
+		description:
+			'Use the Google query strings syntax to search for a specific set of files or folders. <a href="https://developers.google.com/drive/api/v3/search-files" target="_blank">Learn more</a>.',
+	},
+	{
+		displayName: 'Return All',
+		name: 'returnAll',
+		type: 'boolean',
+		default: false,
+		description: 'Whether to return all results or only up to a given limit',
+	},
+	{
+		displayName: 'Limit',
+		name: 'limit',
+		type: 'number',
+		default: 50,
+		description: 'Max number of results to return',
+		typeOptions: {
+			minValue: 1,
+		},
+		displayOptions: {
+			show: {
+				returnAll: [false],
+			},
+		},
+	},
+	{
+		displayName: 'Filter',
+		name: 'filter',
+		type: 'collection',
+		placeholder: 'Add Filter',
+		default: {},
+		options: [
+			{
+				...driveRLC,
+				description:
+					'The drive you want to search in. By default, the personal "My Drive" is used.',
+				required: false,
+			},
+			{
+				...folderRLC,
+				description:
+					'The folder you want to search in. By default, the root folder of the drive is used. If you select a folder other than the root folder, only the direct children will be included.',
+				required: false,
+			},
+			{
+				displayName: 'What to Search',
+				name: 'whatToSearch',
+				type: 'options',
+				default: 'all',
+				options: [
+					{
+						name: 'Files and Folders',
+						value: 'all',
+					},
+					{
+						name: 'Files',
+						value: 'files',
+					},
+					{
+						name: 'Folders',
+						value: 'folders',
+					},
+				],
+			},
+			{
+				displayName: 'File Types',
+				name: 'fileTypes',
+				type: 'multiOptions',
+				default: [],
+				description: 'Return only items corresponding to the selected MIME types',
+				options: fileTypesOptions,
+				displayOptions: {
+					show: {
+						whatToSearch: ['all'],
+					},
+				},
+			},
+			{
+				displayName: 'File Types',
+				name: 'fileTypes',
+				type: 'multiOptions',
+				default: [],
+				description: 'Return only items corresponding to the selected MIME types',
+				options: fileTypesOptions.filter((option) => option.name !== 'Folder'),
+				displayOptions: {
+					show: {
+						whatToSearch: ['files'],
+					},
+				},
+			},
+			{
+				displayName: 'Include Trashed Items',
+				name: 'includeTrashed',
+				type: 'boolean',
+				default: false,
+				description: "Whether to return also items in the Drive's bin",
+			},
+		],
+	},
+	{
+		displayName: 'Options',
+		name: 'options',
+		type: 'collection',
+		placeholder: 'Add option',
+		default: {},
+		options: [
+			{
+				displayName: 'Fields',
+				name: 'fields',
+				type: 'multiOptions',
+				options: [
+					{
+						name: '*',
+						value: '*',
+						description: 'All fields',
+					},
+					{
+						name: 'explicitlyTrashed',
+						value: 'explicitlyTrashed',
+					},
+					{
+						name: 'exportLinks',
+						value: 'exportLinks',
+					},
+					{
+						name: 'hasThumbnail',
+						value: 'hasThumbnail',
+					},
+					{
+						name: 'iconLink',
+						value: 'iconLink',
+					},
+					{
+						name: 'ID',
+						value: 'id',
+					},
+					{
+						name: 'Kind',
+						value: 'kind',
+					},
+					{
+						name: 'mimeType',
+						value: 'mimeType',
+					},
+					{
+						name: 'Name',
+						value: 'name',
+					},
+					{
+						name: 'Permissions',
+						value: 'permissions',
+					},
+					{
+						name: 'Shared',
+						value: 'shared',
+					},
+					{
+						name: 'Spaces',
+						value: 'spaces',
+					},
+					{
+						name: 'Starred',
+						value: 'starred',
+					},
+					{
+						name: 'thumbnailLink',
+						value: 'thumbnailLink',
+					},
+					{
+						name: 'Trashed',
+						value: 'trashed',
+					},
+					{
+						name: 'Version',
+						value: 'version',
+					},
+					{
+						name: 'webViewLink',
+						value: 'webViewLink',
+					},
+				],
+				default: [],
+				description: 'The fields to return',
+			},
+		],
+	},
+];
+
+const displayOptions = {
+	show: {
+		resource: ['fileFolder'],
+		operation: ['search'],
+	},
+};
+
+export const description = updateDisplayOptions(displayOptions, properties);
+
+export async function execute(this: IExecuteFunctions, i: number): Promise<INodeExecutionData[]> {
+	const searchMethod = this.getNodeParameter('searchMethod', i) as string;
+	const options = this.getNodeParameter('options', i, {});
+
+	const query = [];
+
+	const queryString = this.getNodeParameter('queryString', i) as string;
+
+	if (searchMethod === 'name') {
+		query.push(`name contains '${queryString}'`);
+	} else {
+		query.push(queryString);
+	}
+
+	const filter = this.getNodeParameter('filter', i, {}) as SearchFilter;
+
+	let driveId = '';
+	let folderId = '';
+	const returnedTypes: string[] = [];
+
+	if (Object.keys(filter)?.length) {
+		if (filter.folderId) {
+			if (filter.folderId.mode === 'url') {
+				folderId = this.getNodeParameter('filter.folderId', i, undefined, {
+					extractValue: true,
+				}) as string;
+			} else {
+				folderId = filter.folderId.value;
+			}
+		}
+
+		if (folderId && folderId !== RLC_FOLDER_DEFAULT) {
+			query.push(`'${folderId}' in parents`);
+		}
+
+		if (filter.driveId) {
+			let value;
+			if (filter.driveId.mode === 'url') {
+				value = this.getNodeParameter('filter.driveId', i, undefined, {
+					extractValue: true,
+				}) as string;
+			} else {
+				value = filter.driveId.value;
+			}
+			driveId = value;
+		}
+
+		const whatToSearch = filter.whatToSearch || 'all';
+		if (whatToSearch === 'folders') {
+			query.push(`mimeType = '${DRIVE.FOLDER}'`);
+		} else {
+			if (whatToSearch === 'files') {
+				query.push(`mimeType != '${DRIVE.FOLDER}'`);
+			}
+
+			if (filter?.fileTypes?.length && !filter.fileTypes.includes('*')) {
+				filter.fileTypes.forEach((fileType: string) => {
+					returnedTypes.push(`mimeType = '${fileType}'`);
+				});
+			}
+		}
+
+		if (!filter.includeTrashed) {
+			query.push('trashed = false');
+		}
+	}
+
+	if (returnedTypes.length) {
+		query.push(`(${returnedTypes.join(' or ')})`);
+	}
+
+	const queryFields = prepareQueryString(options.fields as string[]);
+
+	const qs: IDataObject = {
+		fields: `nextPageToken, files(${queryFields})`,
+		q: query.filter((q) => q).join(' and '),
+		includeItemsFromAllDrives: true,
+		supportsAllDrives: true,
+		spaces: 'appDataFolder, drive',
+		corpora: 'allDrives',
+	};
+
+	updateDriveScopes(qs, driveId);
+
+	if (!driveId && folderId === RLC_FOLDER_DEFAULT) {
+		qs.corpora = 'user';
+		qs.spaces = 'drive';
+		qs.includeItemsFromAllDrives = false;
+		qs.supportsAllDrives = false;
+	}
+
+	const returnAll = this.getNodeParameter('returnAll', i, false);
+
+	let response;
+	if (returnAll) {
+		response = await googleApiRequestAllItems.call(this, 'GET', 'files', '/drive/v3/files', {}, qs);
+	} else {
+		qs.pageSize = this.getNodeParameter('limit', i);
+		response = await googleApiRequest.call(this, 'GET', '/drive/v3/files', undefined, qs);
+		response = response.files;
+	}
+
+	const executionData = this.helpers.constructExecutionMetaData(
+		this.helpers.returnJsonArray(response as IDataObject[]),
+		{ itemData: { item: i } },
+	);
+
+	return executionData;
+}