Files
n8n-enterprise-unlocked/packages/nodes-base/nodes/Microsoft/AzureCosmosDb/helpers/utils.ts
AdinaTotorean b52f9f0f6c feat(Azure Cosmos DB Node): New node (#14156)
Co-authored-by: feelgood-interface <feelgood.interface@gmail.com>
2025-04-09 15:05:33 +01:00

230 lines
7.1 KiB
TypeScript

import type {
IDataObject,
IExecuteSingleFunctions,
IHttpRequestOptions,
IN8nHttpFullResponse,
INodeExecutionData,
NodeApiError,
} from 'n8n-workflow';
import { jsonParse, NodeOperationError, OperationalError } from 'n8n-workflow';
import { HeaderConstants } from './constants';
import { ErrorMap } from './errorHandler';
import type { IContainer } from './interfaces';
import { azureCosmosDbApiRequest } from '../transport';
export async function getPartitionKey(this: IExecuteSingleFunctions): Promise<string> {
const container = this.getNodeParameter('container', undefined, {
extractValue: true,
}) as string;
let partitionKeyField: string | undefined = undefined;
try {
const responseData = (await azureCosmosDbApiRequest.call(
this,
'GET',
`/colls/${container}`,
)) as IContainer;
partitionKeyField = responseData.partitionKey?.paths[0]?.replace('/', '');
} catch (error) {
const err = error as NodeApiError;
if (err.httpCode === '404') {
err.message = ErrorMap.Container.NotFound.getMessage(container);
err.description = ErrorMap.Container.NotFound.description;
}
throw err;
}
if (!partitionKeyField) {
throw new NodeOperationError(this.getNode(), 'Partition key not found', {
description: 'Failed to determine the partition key for this collection',
});
}
return partitionKeyField;
}
export async function simplifyData(
this: IExecuteSingleFunctions,
items: INodeExecutionData[],
_response: IN8nHttpFullResponse,
): Promise<INodeExecutionData[]> {
const simple = this.getNodeParameter('simple') as boolean;
if (!simple) {
return items;
}
const simplifyFields = (data: IDataObject): IDataObject => {
const simplifiedData = Object.keys(data)
.filter((key) => !key.startsWith('_'))
.reduce((acc, key) => {
acc[key] = data[key];
return acc;
}, {} as IDataObject);
return simplifiedData;
};
return items.map((item) => {
const simplifiedData = simplifyFields(item.json);
return { json: simplifiedData } as INodeExecutionData;
});
}
export async function validateQueryParameters(
this: IExecuteSingleFunctions,
requestOptions: IHttpRequestOptions,
): Promise<IHttpRequestOptions> {
const query = this.getNodeParameter('query', '') as string;
const queryOptions = this.getNodeParameter('options.queryOptions') as IDataObject;
const parameterNames = query.replace(/\$(\d+)/g, '@Param$1').match(/@\w+/g) ?? [];
const queryParamsString = queryOptions?.queryParameters as string;
const parameterValues = queryParamsString
? queryParamsString.split(',').map((param) => param.trim())
: [];
if (parameterNames.length !== parameterValues.length) {
throw new NodeOperationError(this.getNode(), 'Empty parameter value provided', {
description: 'Please provide non-empty values for the query parameters',
});
}
requestOptions.body = {
...(requestOptions.body as IDataObject),
parameters: parameterNames.map((name, index) => ({
name,
value: parameterValues[index],
})),
};
return requestOptions;
}
export function processJsonInput<T>(
jsonData: T,
inputName?: string,
fallbackValue: T | undefined = undefined,
disallowSpacesIn?: string[],
): Record<string, unknown> {
let values: Record<string, unknown> = {};
const input = inputName ? `'${inputName}' ` : '';
if (typeof jsonData === 'string') {
try {
values = jsonParse(jsonData, { fallbackValue }) as Record<string, unknown>;
} catch (error) {
throw new OperationalError(`Input ${input}must contain a valid JSON`, { level: 'warning' });
}
} else if (jsonData && typeof jsonData === 'object') {
values = jsonData as Record<string, unknown>;
} else {
throw new OperationalError(`Input ${input}must contain a valid JSON`, { level: 'warning' });
}
disallowSpacesIn?.forEach((key) => {
const value = values[key];
if (typeof value === 'string' && value.includes(' ')) {
throw new OperationalError(
`${inputName ? `'${inputName}'` : ''} property '${key}' should not contain spaces (received "${value}")`,
{ level: 'warning' },
);
}
});
return values;
}
export async function validatePartitionKey(
this: IExecuteSingleFunctions,
requestOptions: IHttpRequestOptions,
): Promise<IHttpRequestOptions> {
const operation = this.getNodeParameter('operation') as string;
let customProperties = this.getNodeParameter('customProperties', {}) as IDataObject;
const partitionKey = await getPartitionKey.call(this);
if (typeof customProperties === 'string') {
try {
customProperties = jsonParse(customProperties);
} catch (error) {
throw new NodeOperationError(this.getNode(), 'Invalid JSON format in "Item Contents"', {
description: 'Ensure the "Item Contents" field contains a valid JSON object',
});
}
}
let partitionKeyValue: string = '';
const needsPartitionKey = ['update', 'delete', 'get'].includes(operation);
if (operation === 'create') {
if (!(partitionKey in customProperties) || !customProperties[partitionKey]) {
throw new NodeOperationError(this.getNode(), "Partition key not found in 'Item Contents'", {
description: `Partition key '${partitionKey}' must be present and have a valid, non-empty value in 'Item Contents'.`,
});
}
partitionKeyValue = customProperties[partitionKey] as string;
} else if (needsPartitionKey) {
try {
partitionKeyValue =
partitionKey === 'id'
? String(this.getNodeParameter('item', undefined, { extractValue: true }) ?? '')
: String(this.getNodeParameter('additionalFields.partitionKey', undefined) ?? '');
if (!partitionKeyValue) {
throw new NodeOperationError(this.getNode(), 'Partition key is empty', {
description: 'Ensure the "Partition Key" field has a valid, non-empty value.',
});
}
} catch (error) {
throw new NodeOperationError(this.getNode(), 'Partition key is missing or empty', {
description: 'Ensure the "Partition Key" field exists and has a valid, non-empty value.',
});
}
if (operation === 'update') {
const idValue = String(
this.getNodeParameter('item', undefined, { extractValue: true }) ?? '',
);
(requestOptions.body as IDataObject).id = idValue;
(requestOptions.body as IDataObject)[partitionKey] = partitionKeyValue;
}
}
requestOptions.headers = {
...requestOptions.headers,
[HeaderConstants.X_MS_DOCUMENTDB_PARTITIONKEY]: `["${partitionKeyValue}"]`,
};
return requestOptions;
}
export async function validateCustomProperties(
this: IExecuteSingleFunctions,
requestOptions: IHttpRequestOptions,
): Promise<IHttpRequestOptions> {
const rawCustomProperties = this.getNodeParameter('customProperties') as IDataObject;
const customProperties = processJsonInput(rawCustomProperties, 'Item Contents');
if (
Object.keys(customProperties).length === 0 ||
Object.values(customProperties).every((val) => val === undefined || val === null || val === '')
) {
throw new NodeOperationError(this.getNode(), 'Item contents are empty', {
description: 'Ensure the "Item Contents" field contains at least one valid property.',
});
}
requestOptions.body = {
...(requestOptions.body as IDataObject),
...customProperties,
};
return requestOptions;
}
export const untilContainerSelected = { container: [''] };
export const untilItemSelected = { item: [''] };