n8n/packages/nodes-base/credentials/WooCommerceApi.credentials.ts
Iván Ovejero b03e358a12
refactor: Integrate consistent-type-imports in nodes-base (no-changelog) (#5267)
* 👕 Enable `consistent-type-imports` for nodes-base

* 👕 Apply to nodes-base

*  Undo unrelated changes

* 🚚 Move to `.eslintrc.js` in nodes-base

*  Revert "Enable `consistent-type-imports` for nodes-base"

This reverts commit 529ad72b05.

* 👕 Fix severity
2023-01-27 12:22:44 +01:00

72 lines
1.8 KiB
TypeScript

import type {
ICredentialDataDecryptedObject,
ICredentialTestRequest,
ICredentialType,
IHttpRequestOptions,
INodeProperties,
} from 'n8n-workflow';
export class WooCommerceApi implements ICredentialType {
name = 'wooCommerceApi';
displayName = 'WooCommerce API';
documentationUrl = 'wooCommerce';
properties: INodeProperties[] = [
{
displayName: 'Consumer Key',
name: 'consumerKey',
type: 'string',
default: '',
},
{
displayName: 'Consumer Secret',
name: 'consumerSecret',
type: 'string',
default: '',
},
{
displayName: 'WooCommerce URL',
name: 'url',
type: 'string',
default: '',
placeholder: 'https://example.com',
},
{
displayName: 'Include Credentials in Query',
name: 'includeCredentialsInQuery',
type: 'boolean',
default: false,
description:
'Whether credentials should be included in the query. Occasionally, some servers may not parse the Authorization header correctly (if you see a “Consumer key is missing” error when authenticating over SSL, you have a server issue). In this case, you may provide the consumer key/secret as query string parameters instead.',
},
];
async authenticate(
credentials: ICredentialDataDecryptedObject,
requestOptions: IHttpRequestOptions,
): Promise<IHttpRequestOptions> {
requestOptions.auth = {
// @ts-ignore
user: credentials.consumerKey as string,
password: credentials.consumerSecret as string,
};
if (credentials.includeCredentialsInQuery === true && requestOptions.qs) {
delete requestOptions.auth;
Object.assign(requestOptions.qs, {
consumer_key: credentials.consumerKey,
consumer_secret: credentials.consumerSecret,
});
}
return requestOptions;
}
test: ICredentialTestRequest = {
request: {
baseURL: '={{$credentials.url}}/wp-json/wc/v3',
url: '/products/categories',
},
};
}