feat: Support metadata query with array (#581)

Author: congminh1254

src/commands/metadata-query.js

@@ -8,26 +8,48 @@ class MetadataQueryCommand extends BoxCommand {
 	async run() {
 		const { flags, args } = await this.parse(MetadataQueryCommand);
 
-		const { extra_fields: extraFields, ...rest } = mapKeys(
-			omit(flags, Object.keys(BoxCommand.flags)),
-			(value, key) => snakeCase(key)
+		const {
+			extra_fields: extraFields,
+			query_params: queryParams,
+			query_param: queryParam,
+			query_param_array: queryParamArray,
+			...rest
+		} = mapKeys(omit(flags, Object.keys(BoxCommand.flags)), (value, key) =>
+			snakeCase(key),
 		);
 
+		let combinedQueryParams = queryParams || {};
+		if (queryParam) {
+			combinedQueryParams = {
+				...combinedQueryParams,
+				...queryParam,
+			};
+		}
+		if (queryParamArray) {
+			combinedQueryParams = {
+				...combinedQueryParams,
+				...queryParamArray,
+			};
+		}
+
 		const items = await this.client.metadata.query(
 			args.from,
 			args.ancestorFolderId,
 			{
 				...(extraFields && { fields: extraFields }),
+				...(combinedQueryParams && { query_params: combinedQueryParams }),
 				...rest,
-			}
+			},
 		);
 		await this.output(items);
 	}
 }
 
 MetadataQueryCommand.description =
 	'Create a search using SQL-like syntax to return items that match specific metadata';
-MetadataQueryCommand.examples = ['box metadata-query enterprise_12345.someTemplate 5555 --query "amount >= :minAmount AND amount <= :maxAmount" --query-params minAmount=100f,maxAmount=200f --use-index amountAsc --order-by amount=ASC --extra-fields created_at,metadata.enterprise_1234.contracts'];
+MetadataQueryCommand.examples = [
+	'box metadata-query enterprise_12345.someTemplate 5555 --query "amount >= :minAmount AND amount <= :maxAmount" --query-params minAmount=100f,maxAmount=200f --use-index amountAsc --order-by amount=ASC --extra-fields created_at,metadata.enterprise_1234.contracts',
+];
 MetadataQueryCommand._endpoint = 'post_metadata_queries_execute_read';
 
 MetadataQueryCommand.flags = {
@@ -36,16 +58,14 @@ MetadataQueryCommand.flags = {
 		description: 'The logical expression of the query',
 	}),
 	'query-params': Flags.string({
-		description: 'Required if query present. The arguments for the query.',
+		description:
+			'The arguments for the query. Can be specified as a comma-separated list of key-value pairs. i.e. key1=value1,key2=value2',
 		dependsOn: ['query'],
 		parse(input) {
 			return Object.assign(
 				{},
-				...input.split(',').map(param => {
-					const [
-						key,
-						value
-					] = param.split('=');
+				...input.split(',').map((param) => {
+					const [key, value] = param.split('=');
 					/* eslint-disable multiline-ternary */
 					return {
 						[key]:
@@ -54,22 +74,42 @@ MetadataQueryCommand.flags = {
 								: value,
 					};
 					/* eslint-enable multiline-ternary */
-				})
+				}),
 			);
 		},
 	}),
+	'query-param': Flags.string({
+		description: 'One query param key-value pair, i.e. key=value. If this key duplicates with query-params, this flag will take precedence.',
+		dependsOn: ['query'],
+		parse(input) {
+			const key = input.split('=')[0];
+			const value = input.substring(key.length + 1);
+			return {
+				[key]: value,
+			};
+		},
+	}),
+	'query-param-array': Flags.string({
+		description:
+			'One query param key-multiple-value pair, use for multiple-values fields, i.e. key=value1,value2,value3. If this key duplicates with query-params or query-param, this flag will take precedence.',
+		dependsOn: ['query'],
+		parse(input) {
+			const key = input.split('=')[0];
+			const value = input.substring(key.length + 1).split(',');
+			return {
+				[key]: value,
+			};
+		},
+	}),
 	'use-index': Flags.string({
 		description: 'The name of the search index to use for this query.',
 	}),
 	'order-by': Flags.string({
 		description:
 			'A list of template fields and directions to sort the metadata query results by.',
 		parse(input) {
-			return input.split(',').map(param => {
-				const [
-					fieldKey,
-					direction
-				] = param.split('=');
+			return input.split(',').map((param) => {
+				const [fieldKey, direction] = param.split('=');
 				return { field_key: fieldKey, direction };
 			});
 		},

test/commands/metadata-query.test.js

@@ -26,6 +26,26 @@ describe('Metadata Query', () => {
 				],
 				limit: 100,
 			},
+			requestWithMultipleValues = {
+				from: 'enterprise_123456.contractTemplate',
+				query: 'name = :customerName',
+				query_params: {
+					customerName: ['John Doe', 'Jane Doe'],
+				},
+				fields: [
+					'created_at',
+					'metadata.enterprise_123456.contractTemplate.amount',
+					'metadata.enterprise_123456.contractTemplate.customerName',
+				],
+				ancestor_folder_id: '5555',
+				order_by: [
+					{
+						field_key: 'amount',
+						direction: 'asc',
+					},
+				],
+				limit: 100,
+			},
 			fixture = getFixture('metadata-query/post_metadata_queries_execute_read');
 
 		test
@@ -49,5 +69,27 @@ describe('Metadata Query', () => {
 			.it('should query metadata', ctx => {
 				assert.equal(ctx.stdout, fixture);
 			});
+
+		test
+			.nock(TEST_API_ROOT, api => api
+				.post('/2.0/metadata_queries/execute_read', requestWithMultipleValues)
+				.reply(200, fixture)
+			)
+			.stdout()
+			.command([
+				'metadata-query',
+				requestWithMultipleValues.from,
+				requestWithMultipleValues.ancestor_folder_id,
+				`--query=${requestWithMultipleValues.query}`,
+				`--query-param-array=customerName=${requestWithMultipleValues.query_params.customerName.join(',')}`,
+				`--extra-fields=${requestWithMultipleValues.fields.join(',')}`,
+				`--order-by=${requestWithMultipleValues.order_by[0].field_key}=${requestWithMultipleValues.order_by[0].direction}`,
+				`--limit=${requestWithMultipleValues.limit}`,
+				'--json',
+				'--token=test',
+			])
+			.it('should query metadata with query-param', ctx => {
+				assert.equal(ctx.stdout, fixture);
+			});
 	});
 });