Add self-hosted support to ERPNext (#1679)

This commit is contained in:
Iván Ovejero 2021-04-30 20:37:46 +02:00 committed by GitHub
parent 7f0f8deb6d
commit b6d45e30ef
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 60 additions and 7 deletions

View file

@ -20,13 +20,51 @@ export class ERPNextApi implements ICredentialType {
type: 'string' as NodePropertyTypes,
default: '',
},
{
displayName: 'Environment',
name: 'environment',
type: 'options' as NodePropertyTypes,
default: 'cloudHosted',
options: [
{
name: 'Cloud-hosted',
value: 'cloudHosted',
},
{
name: 'Self-hosted',
value: 'selfHosted',
},
],
},
{
displayName: 'Subdomain',
name: 'subdomain',
type: 'string' as NodePropertyTypes,
default: '',
placeholder: 'n8n',
description: 'ERPNext subdomain. For instance, entering n8n will make the url look like: https://n8n.erpnext.com/.',
description: 'Subdomain of cloud-hosted ERPNext instance. For example, "n8n" is the subdomain in: <code>https://n8n.erpnext.com</code>',
displayOptions: {
show: {
environment: [
'cloudHosted',
],
},
},
},
{
displayName: 'Domain',
name: 'domain',
type: 'string' as NodePropertyTypes,
default: '',
placeholder: 'https://www.mydomain.com',
description: 'Fully qualified domain name of self-hosted ERPNext instance.',
displayOptions: {
show: {
environment: [
'selfHosted',
],
},
},
},
];
}

View file

@ -24,8 +24,8 @@ export async function erpNextApiRequest(
uri?: string,
option: IDataObject = {},
) {
const credentials = this.getCredentials('erpNextApi');
const credentials = this.getCredentials('erpNextApi') as ERPNextApiCredentials;
const baseUrl = getBaseUrl(credentials);
if (credentials === undefined) {
throw new NodeOperationError(this.getNode(), 'No credentials got returned!');
@ -40,7 +40,7 @@ export async function erpNextApiRequest(
method,
body,
qs: query,
uri: uri || `https://${credentials.subdomain}.erpnext.com${resource}`,
uri: uri || `${baseUrl}${resource}`,
json: true,
};
@ -56,13 +56,12 @@ export async function erpNextApiRequest(
try {
return await this.helpers.request!(options);
} catch (error) {
if (error.statusCode === 403) {
throw new NodeApiError(this.getNode(), { message: `DocType unavailable.` });
throw new NodeApiError(this.getNode(), { message: 'DocType unavailable.' });
}
if (error.statusCode === 307) {
throw new NodeApiError(this.getNode(), { message:`Please ensure the subdomain is correct.` });
throw new NodeApiError(this.getNode(), { message: 'Please ensure the subdomain is correct.' });
}
throw new NodeApiError(this.getNode(), error);
@ -95,3 +94,19 @@ export async function erpNextApiRequestAllItems(
return returnData;
}
/**
* Return the base API URL based on the user's environment.
*/
const getBaseUrl = ({ environment, domain, subdomain }: ERPNextApiCredentials) =>
environment === 'cloudHosted'
? `https://${subdomain}.erpnext.com`
: domain;
type ERPNextApiCredentials = {
apiKey: string;
apiSecret: string;
environment: 'cloudHosted' | 'selfHosted';
subdomain?: string;
domain?: string;
};