mirror of
https://github.com/n8n-io/n8n.git
synced 2024-11-14 16:44:07 -08:00
770 lines
19 KiB
TypeScript
770 lines
19 KiB
TypeScript
import type {
|
|
IExecuteFunctions,
|
|
ICredentialsDecrypted,
|
|
ICredentialTestFunctions,
|
|
IDataObject,
|
|
ILoadOptionsFunctions,
|
|
INodeCredentialTestResult,
|
|
INodeExecutionData,
|
|
INodePropertyOptions,
|
|
INodeType,
|
|
INodeTypeDescription,
|
|
IRequestOptions,
|
|
} from 'n8n-workflow';
|
|
import { deepCopy, randomInt } from 'n8n-workflow';
|
|
|
|
import { capitalCase } from 'change-case';
|
|
import {
|
|
contactDescription,
|
|
contactOperations,
|
|
customResourceDescription,
|
|
customResourceOperations,
|
|
noteDescription,
|
|
noteOperations,
|
|
opportunityDescription,
|
|
opportunityOperations,
|
|
} from './descriptions';
|
|
|
|
import type { IOdooFilterOperations } from './GenericFunctions';
|
|
import {
|
|
odooCreate,
|
|
odooDelete,
|
|
odooGet,
|
|
odooGetAll,
|
|
odooGetDBName,
|
|
odooGetModelFields,
|
|
odooGetUserID,
|
|
odooJSONRPCRequest,
|
|
odooUpdate,
|
|
processNameValueFields,
|
|
} from './GenericFunctions';
|
|
|
|
export class Odoo implements INodeType {
|
|
description: INodeTypeDescription = {
|
|
displayName: 'Odoo',
|
|
name: 'odoo',
|
|
icon: 'file:odoo.svg',
|
|
group: ['transform'],
|
|
version: 1,
|
|
description: 'Consume Odoo API',
|
|
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
|
|
defaults: {
|
|
name: 'Odoo',
|
|
},
|
|
inputs: ['main'],
|
|
outputs: ['main'],
|
|
credentials: [
|
|
{
|
|
name: 'odooApi',
|
|
required: true,
|
|
testedBy: 'odooApiTest',
|
|
},
|
|
],
|
|
properties: [
|
|
{
|
|
displayName: 'Resource',
|
|
name: 'resource',
|
|
type: 'options',
|
|
default: 'contact',
|
|
noDataExpression: true,
|
|
options: [
|
|
{
|
|
name: 'Contact',
|
|
value: 'contact',
|
|
},
|
|
{
|
|
name: 'Custom Resource',
|
|
value: 'custom',
|
|
},
|
|
{
|
|
name: 'Note',
|
|
value: 'note',
|
|
},
|
|
{
|
|
name: 'Opportunity',
|
|
value: 'opportunity',
|
|
},
|
|
],
|
|
},
|
|
|
|
...customResourceOperations,
|
|
...customResourceDescription,
|
|
...opportunityOperations,
|
|
...opportunityDescription,
|
|
...contactOperations,
|
|
...contactDescription,
|
|
...noteOperations,
|
|
...noteDescription,
|
|
],
|
|
};
|
|
|
|
methods = {
|
|
loadOptions: {
|
|
async getModelFields(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
|
|
let resource;
|
|
resource = this.getCurrentNodeParameter('resource') as string;
|
|
if (resource === 'custom') {
|
|
resource = this.getCurrentNodeParameter('customResource') as string;
|
|
if (!resource) return [];
|
|
}
|
|
|
|
const credentials = await this.getCredentials('odooApi');
|
|
const url = credentials.url as string;
|
|
const username = credentials.username as string;
|
|
const password = credentials.password as string;
|
|
const db = odooGetDBName(credentials.db as string, url);
|
|
const userID = await odooGetUserID.call(this, db, username, password, url);
|
|
|
|
const response = await odooGetModelFields.call(this, db, userID, password, resource, url);
|
|
const options = Object.values(response).map((field) => {
|
|
const optionField = field as { [key: string]: string };
|
|
let name = '';
|
|
try {
|
|
name = capitalCase(optionField.name);
|
|
} catch (error) {
|
|
name = optionField.name;
|
|
}
|
|
return {
|
|
name,
|
|
value: optionField.name,
|
|
// nodelinter-ignore-next-line
|
|
description: `name: ${optionField?.name}, type: ${optionField?.type} required: ${optionField?.required}`,
|
|
};
|
|
});
|
|
|
|
return options.sort((a, b) => a.name?.localeCompare(b.name) || 0);
|
|
},
|
|
async getModels(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
|
|
const credentials = await this.getCredentials('odooApi');
|
|
const url = credentials.url as string;
|
|
const username = credentials.username as string;
|
|
const password = credentials.password as string;
|
|
const db = odooGetDBName(credentials.db as string, url);
|
|
const userID = await odooGetUserID.call(this, db, username, password, url);
|
|
|
|
const body = {
|
|
jsonrpc: '2.0',
|
|
method: 'call',
|
|
params: {
|
|
service: 'object',
|
|
method: 'execute',
|
|
args: [
|
|
db,
|
|
userID,
|
|
password,
|
|
'ir.model',
|
|
'search_read',
|
|
[],
|
|
['name', 'model', 'modules'],
|
|
],
|
|
},
|
|
id: randomInt(100),
|
|
};
|
|
|
|
const response = (await odooJSONRPCRequest.call(this, body, url)) as IDataObject[];
|
|
|
|
const options = response.map((model) => {
|
|
return {
|
|
name: model.name,
|
|
value: model.model,
|
|
description: `model: ${model.model}<br> modules: ${model.modules}`,
|
|
};
|
|
});
|
|
return options as INodePropertyOptions[];
|
|
},
|
|
async getStates(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
|
|
const credentials = await this.getCredentials('odooApi');
|
|
const url = credentials.url as string;
|
|
const username = credentials.username as string;
|
|
const password = credentials.password as string;
|
|
const db = odooGetDBName(credentials.db as string, url);
|
|
const userID = await odooGetUserID.call(this, db, username, password, url);
|
|
|
|
const body = {
|
|
jsonrpc: '2.0',
|
|
method: 'call',
|
|
params: {
|
|
service: 'object',
|
|
method: 'execute',
|
|
args: [db, userID, password, 'res.country.state', 'search_read', [], ['id', 'name']],
|
|
},
|
|
id: randomInt(100),
|
|
};
|
|
|
|
const response = (await odooJSONRPCRequest.call(this, body, url)) as IDataObject[];
|
|
|
|
const options = response.map((state) => {
|
|
return {
|
|
name: state.name as string,
|
|
value: state.id,
|
|
};
|
|
});
|
|
return options.sort((a, b) => a.name?.localeCompare(b.name) || 0) as INodePropertyOptions[];
|
|
},
|
|
async getCountries(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
|
|
const credentials = await this.getCredentials('odooApi');
|
|
const url = credentials.url as string;
|
|
const username = credentials.username as string;
|
|
const password = credentials.password as string;
|
|
const db = odooGetDBName(credentials.db as string, url);
|
|
const userID = await odooGetUserID.call(this, db, username, password, url);
|
|
|
|
const body = {
|
|
jsonrpc: '2.0',
|
|
method: 'call',
|
|
params: {
|
|
service: 'object',
|
|
method: 'execute',
|
|
args: [db, userID, password, 'res.country', 'search_read', [], ['id', 'name']],
|
|
},
|
|
id: randomInt(100),
|
|
};
|
|
|
|
const response = (await odooJSONRPCRequest.call(this, body, url)) as IDataObject[];
|
|
|
|
const options = response.map((country) => {
|
|
return {
|
|
name: country.name as string,
|
|
value: country.id,
|
|
};
|
|
});
|
|
|
|
return options.sort((a, b) => a.name?.localeCompare(b.name) || 0) as INodePropertyOptions[];
|
|
},
|
|
},
|
|
credentialTest: {
|
|
async odooApiTest(
|
|
this: ICredentialTestFunctions,
|
|
credential: ICredentialsDecrypted,
|
|
): Promise<INodeCredentialTestResult> {
|
|
const credentials = credential.data;
|
|
|
|
try {
|
|
const body = {
|
|
jsonrpc: '2.0',
|
|
method: 'call',
|
|
params: {
|
|
service: 'common',
|
|
method: 'login',
|
|
args: [
|
|
odooGetDBName(credentials?.db as string, credentials?.url as string),
|
|
credentials?.username,
|
|
credentials?.password,
|
|
],
|
|
},
|
|
id: randomInt(100),
|
|
};
|
|
|
|
const options: IRequestOptions = {
|
|
headers: {
|
|
'User-Agent': 'n8n',
|
|
Connection: 'keep-alive',
|
|
Accept: '*/*',
|
|
'Content-Type': 'application/json',
|
|
},
|
|
method: 'POST',
|
|
body,
|
|
uri: `${(credentials?.url as string).replace(/\/$/, '')}/jsonrpc`,
|
|
json: true,
|
|
};
|
|
const result = await this.helpers.request(options);
|
|
if (result.error || !result.result) {
|
|
return {
|
|
status: 'Error',
|
|
message: 'Credentials are not valid',
|
|
};
|
|
} else if (result.error) {
|
|
return {
|
|
status: 'Error',
|
|
message: `Credentials are not valid: ${result.error.data.message}`,
|
|
};
|
|
}
|
|
} catch (error) {
|
|
return {
|
|
status: 'Error',
|
|
message: `Settings are not valid: ${error}`,
|
|
};
|
|
}
|
|
return {
|
|
status: 'OK',
|
|
message: 'Authentication successful!',
|
|
};
|
|
},
|
|
},
|
|
};
|
|
|
|
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
|
|
let items = this.getInputData();
|
|
items = deepCopy(items);
|
|
const returnData: INodeExecutionData[] = [];
|
|
let responseData;
|
|
|
|
const resource = this.getNodeParameter('resource', 0);
|
|
const operation = this.getNodeParameter('operation', 0);
|
|
|
|
const credentials = await this.getCredentials('odooApi');
|
|
const url = (credentials.url as string).replace(/\/$/, '');
|
|
const username = credentials.username as string;
|
|
const password = credentials.password as string;
|
|
const db = odooGetDBName(credentials.db as string, url);
|
|
const userID = await odooGetUserID.call(this, db, username, password, url);
|
|
|
|
//----------------------------------------------------------------------
|
|
// Main loop
|
|
//----------------------------------------------------------------------
|
|
|
|
for (let i = 0; i < items.length; i++) {
|
|
try {
|
|
if (resource === 'contact') {
|
|
if (operation === 'create') {
|
|
let additionalFields = this.getNodeParameter('additionalFields', i);
|
|
|
|
if (additionalFields.address) {
|
|
const addressFields = (additionalFields.address as IDataObject).value as IDataObject;
|
|
if (addressFields) {
|
|
additionalFields = {
|
|
...additionalFields,
|
|
...addressFields,
|
|
};
|
|
}
|
|
delete additionalFields.address;
|
|
}
|
|
|
|
const name = this.getNodeParameter('contactName', i) as string;
|
|
const fields: IDataObject = {
|
|
name,
|
|
...additionalFields,
|
|
};
|
|
responseData = await odooCreate.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
resource,
|
|
operation,
|
|
url,
|
|
fields,
|
|
);
|
|
}
|
|
|
|
if (operation === 'delete') {
|
|
const contactId = this.getNodeParameter('contactId', i) as string;
|
|
responseData = await odooDelete.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
resource,
|
|
operation,
|
|
url,
|
|
contactId,
|
|
);
|
|
}
|
|
|
|
if (operation === 'get') {
|
|
const contactId = this.getNodeParameter('contactId', i) as string;
|
|
const options = this.getNodeParameter('options', i);
|
|
const fields = (options.fieldsList as IDataObject[]) || [];
|
|
responseData = await odooGet.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
resource,
|
|
operation,
|
|
url,
|
|
contactId,
|
|
fields,
|
|
);
|
|
}
|
|
|
|
if (operation === 'getAll') {
|
|
const returnAll = this.getNodeParameter('returnAll', i);
|
|
const options = this.getNodeParameter('options', i);
|
|
const fields = (options.fieldsList as IDataObject[]) || [];
|
|
if (returnAll) {
|
|
responseData = await odooGetAll.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
resource,
|
|
operation,
|
|
url,
|
|
undefined,
|
|
fields,
|
|
);
|
|
} else {
|
|
const limit = this.getNodeParameter('limit', i);
|
|
responseData = await odooGetAll.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
resource,
|
|
operation,
|
|
url,
|
|
undefined, // filters, only for custom resource
|
|
fields,
|
|
limit,
|
|
);
|
|
}
|
|
}
|
|
|
|
if (operation === 'update') {
|
|
const contactId = this.getNodeParameter('contactId', i) as string;
|
|
let updateFields = this.getNodeParameter('updateFields', i);
|
|
|
|
if (updateFields.address) {
|
|
const addressFields = (updateFields.address as IDataObject).value as IDataObject;
|
|
if (addressFields) {
|
|
updateFields = {
|
|
...updateFields,
|
|
...addressFields,
|
|
};
|
|
}
|
|
delete updateFields.address;
|
|
}
|
|
|
|
responseData = await odooUpdate.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
resource,
|
|
operation,
|
|
url,
|
|
contactId,
|
|
updateFields,
|
|
);
|
|
}
|
|
}
|
|
|
|
if (resource === 'custom') {
|
|
const customResource = this.getNodeParameter('customResource', i) as string;
|
|
if (operation === 'create') {
|
|
const fields = this.getNodeParameter('fieldsToCreateOrUpdate', i) as IDataObject;
|
|
responseData = await odooCreate.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
customResource,
|
|
operation,
|
|
url,
|
|
processNameValueFields(fields),
|
|
);
|
|
}
|
|
|
|
if (operation === 'delete') {
|
|
const customResourceId = this.getNodeParameter('customResourceId', i) as string;
|
|
responseData = await odooDelete.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
customResource,
|
|
operation,
|
|
url,
|
|
customResourceId,
|
|
);
|
|
}
|
|
|
|
if (operation === 'get') {
|
|
const customResourceId = this.getNodeParameter('customResourceId', i) as string;
|
|
const options = this.getNodeParameter('options', i);
|
|
const fields = (options.fieldsList as IDataObject[]) || [];
|
|
responseData = await odooGet.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
customResource,
|
|
operation,
|
|
url,
|
|
customResourceId,
|
|
fields,
|
|
);
|
|
}
|
|
|
|
if (operation === 'getAll') {
|
|
const returnAll = this.getNodeParameter('returnAll', i);
|
|
const options = this.getNodeParameter('options', i);
|
|
const fields = (options.fieldsList as IDataObject[]) || [];
|
|
const filter = this.getNodeParameter('filterRequest', i) as IOdooFilterOperations;
|
|
if (returnAll) {
|
|
responseData = await odooGetAll.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
customResource,
|
|
operation,
|
|
url,
|
|
filter,
|
|
fields,
|
|
);
|
|
} else {
|
|
const limit = this.getNodeParameter('limit', i);
|
|
responseData = await odooGetAll.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
customResource,
|
|
operation,
|
|
url,
|
|
filter,
|
|
fields,
|
|
limit,
|
|
);
|
|
}
|
|
}
|
|
|
|
if (operation === 'update') {
|
|
const customResourceId = this.getNodeParameter('customResourceId', i) as string;
|
|
const fields = this.getNodeParameter('fieldsToCreateOrUpdate', i) as IDataObject;
|
|
responseData = await odooUpdate.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
customResource,
|
|
operation,
|
|
url,
|
|
customResourceId,
|
|
processNameValueFields(fields),
|
|
);
|
|
}
|
|
}
|
|
|
|
if (resource === 'note') {
|
|
if (operation === 'create') {
|
|
// const additionalFields = this.getNodeParameter('additionalFields', i);
|
|
const memo = this.getNodeParameter('memo', i) as string;
|
|
const fields: IDataObject = {
|
|
memo,
|
|
// ...additionalFields,
|
|
};
|
|
responseData = await odooCreate.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
resource,
|
|
operation,
|
|
url,
|
|
fields,
|
|
);
|
|
}
|
|
|
|
if (operation === 'delete') {
|
|
const noteId = this.getNodeParameter('noteId', i) as string;
|
|
responseData = await odooDelete.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
resource,
|
|
operation,
|
|
url,
|
|
noteId,
|
|
);
|
|
}
|
|
|
|
if (operation === 'get') {
|
|
const noteId = this.getNodeParameter('noteId', i) as string;
|
|
const options = this.getNodeParameter('options', i);
|
|
const fields = (options.fieldsList as IDataObject[]) || [];
|
|
responseData = await odooGet.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
resource,
|
|
operation,
|
|
url,
|
|
noteId,
|
|
fields,
|
|
);
|
|
}
|
|
|
|
if (operation === 'getAll') {
|
|
const returnAll = this.getNodeParameter('returnAll', i);
|
|
const options = this.getNodeParameter('options', i);
|
|
const fields = (options.fieldsList as IDataObject[]) || [];
|
|
if (returnAll) {
|
|
responseData = await odooGetAll.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
resource,
|
|
operation,
|
|
url,
|
|
undefined,
|
|
fields,
|
|
);
|
|
} else {
|
|
const limit = this.getNodeParameter('limit', i);
|
|
responseData = await odooGetAll.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
resource,
|
|
operation,
|
|
url,
|
|
undefined, // filters, only for custom resource
|
|
fields,
|
|
limit,
|
|
);
|
|
}
|
|
}
|
|
|
|
if (operation === 'update') {
|
|
const noteId = this.getNodeParameter('noteId', i) as string;
|
|
const memo = this.getNodeParameter('memo', i) as string;
|
|
const fields: IDataObject = {
|
|
memo,
|
|
};
|
|
responseData = await odooUpdate.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
resource,
|
|
operation,
|
|
url,
|
|
noteId,
|
|
fields,
|
|
);
|
|
}
|
|
}
|
|
|
|
if (resource === 'opportunity') {
|
|
if (operation === 'create') {
|
|
const additionalFields = this.getNodeParameter('additionalFields', i);
|
|
const name = this.getNodeParameter('opportunityName', i) as string;
|
|
const fields: IDataObject = {
|
|
name,
|
|
...additionalFields,
|
|
};
|
|
|
|
responseData = await odooCreate.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
resource,
|
|
operation,
|
|
url,
|
|
fields,
|
|
);
|
|
}
|
|
|
|
if (operation === 'delete') {
|
|
const opportunityId = this.getNodeParameter('opportunityId', i) as string;
|
|
responseData = await odooDelete.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
resource,
|
|
operation,
|
|
url,
|
|
opportunityId,
|
|
);
|
|
}
|
|
|
|
if (operation === 'get') {
|
|
const opportunityId = this.getNodeParameter('opportunityId', i) as string;
|
|
const options = this.getNodeParameter('options', i);
|
|
const fields = (options.fieldsList as IDataObject[]) || [];
|
|
responseData = await odooGet.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
resource,
|
|
operation,
|
|
url,
|
|
opportunityId,
|
|
fields,
|
|
);
|
|
}
|
|
|
|
if (operation === 'getAll') {
|
|
const returnAll = this.getNodeParameter('returnAll', i);
|
|
const options = this.getNodeParameter('options', i);
|
|
const fields = (options.fieldsList as IDataObject[]) || [];
|
|
if (returnAll) {
|
|
responseData = await odooGetAll.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
resource,
|
|
operation,
|
|
url,
|
|
undefined,
|
|
fields,
|
|
);
|
|
} else {
|
|
const limit = this.getNodeParameter('limit', i);
|
|
responseData = await odooGetAll.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
resource,
|
|
operation,
|
|
url,
|
|
undefined, // filters, only for custom resource
|
|
fields,
|
|
limit,
|
|
);
|
|
}
|
|
}
|
|
|
|
if (operation === 'update') {
|
|
const opportunityId = this.getNodeParameter('opportunityId', i) as string;
|
|
const updateFields = this.getNodeParameter('updateFields', i);
|
|
responseData = await odooUpdate.call(
|
|
this,
|
|
db,
|
|
userID,
|
|
password,
|
|
resource,
|
|
operation,
|
|
url,
|
|
opportunityId,
|
|
updateFields,
|
|
);
|
|
}
|
|
}
|
|
if (responseData !== undefined) {
|
|
const executionData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray(responseData),
|
|
{ itemData: { item: i } },
|
|
);
|
|
returnData.push(...executionData);
|
|
}
|
|
} catch (error) {
|
|
if (this.continueOnFail()) {
|
|
const executionData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray({ error: error.message }),
|
|
{ itemData: { item: i } },
|
|
);
|
|
returnData.push(...executionData);
|
|
|
|
continue;
|
|
}
|
|
throw error;
|
|
}
|
|
}
|
|
|
|
return [returnData];
|
|
}
|
|
}
|