import type { Request } from 'aws4'; import { sign } from 'aws4'; import get from 'lodash.get'; import type { OptionsWithUri } from 'request'; import { parseString } from 'xml2js'; import type { IDataObject, IExecuteFunctions, IHookFunctions, ILoadOptionsFunctions, IWebhookFunctions, JsonObject, } from 'n8n-workflow'; import { NodeApiError, NodeOperationError } from 'n8n-workflow'; import { URL } from 'url'; function queryToString(params: IDataObject) { return Object.keys(params) .map((key) => key + '=' + (params[key] as string)) .join('&'); } export async function s3ApiRequest( this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions | IWebhookFunctions, bucket: string, method: string, path: string, body?: string | Buffer, query: IDataObject = {}, headers?: object, option: IDataObject = {}, region?: string, ): Promise { const credentials = await this.getCredentials('s3'); if (!(credentials.endpoint as string).startsWith('http')) { throw new NodeOperationError( this.getNode(), 'HTTP(S) Scheme is required in endpoint definition', ); } const endpoint = new URL(credentials.endpoint as string); if (bucket) { if (credentials.forcePathStyle) { path = `/${bucket}${path}`; } else { endpoint.host = `${bucket}.${endpoint.host}`; } } endpoint.pathname = path; // Sign AWS API request with the user credentials const signOpts = { headers: headers || {}, region: region || credentials.region, host: endpoint.host, method, path: `${path}?${queryToString(query).replace(/\+/g, '%2B')}`, service: 's3', body, } as Request; const securityHeaders = { accessKeyId: `${credentials.accessKeyId}`.trim(), secretAccessKey: `${credentials.secretAccessKey}`.trim(), sessionToken: credentials.temporaryCredentials ? `${credentials.sessionToken}`.trim() : undefined, }; sign(signOpts, securityHeaders); const options: OptionsWithUri = { headers: signOpts.headers, method, qs: query, uri: endpoint.toString(), body: signOpts.body, }; if (Object.keys(option).length !== 0) { Object.assign(options, option); } try { return await this.helpers.request(options); } catch (error) { throw new NodeApiError(this.getNode(), error as JsonObject); } } export async function s3ApiRequestREST( this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions, bucket: string, method: string, path: string, body?: string, query: IDataObject = {}, headers?: object, options: IDataObject = {}, region?: string, ): Promise { const response = await s3ApiRequest.call( this, bucket, method, path, body, query, headers, options, region, ); try { return JSON.parse(response as string); } catch (error) { return response; } } export async function s3ApiRequestSOAP( this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions | IWebhookFunctions, bucket: string, method: string, path: string, body?: string | Buffer, query: IDataObject = {}, headers?: object, option: IDataObject = {}, region?: string, ): Promise { const response = await s3ApiRequest.call( this, bucket, method, path, body, query, headers, option, region, ); try { return await new Promise((resolve, reject) => { parseString(response as string, { explicitArray: false }, (err, data) => { if (err) { return reject(err); } resolve(data); }); }); } catch (error) { return error; } } export async function s3ApiRequestSOAPAllItems( this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions | IWebhookFunctions, propertyName: string, service: string, method: string, path: string, body?: string, query: IDataObject = {}, headers: IDataObject = {}, option: IDataObject = {}, region?: string, ): Promise { const returnData: IDataObject[] = []; let responseData; do { responseData = await s3ApiRequestSOAP.call( this, service, method, path, body, query, headers, option, region, ); //https://forums.aws.amazon.com/thread.jspa?threadID=55746 if (get(responseData, `${propertyName.split('.')[0]}.NextContinuationToken`)) { query['continuation-token'] = get( responseData, `${propertyName.split('.')[0]}.NextContinuationToken`, ); } if (get(responseData, propertyName)) { if (Array.isArray(get(responseData, propertyName))) { returnData.push.apply(returnData, get(responseData, propertyName) as IDataObject[]); } else { returnData.push(get(responseData, propertyName) as IDataObject); } } if (query.limit && query.limit <= returnData.length) { return returnData; } } while ( get(responseData, `${propertyName.split('.')[0]}.IsTruncated`) !== undefined && get(responseData, `${propertyName.split('.')[0]}.IsTruncated`) !== 'false' ); return returnData; }