mirror of
https://github.com/n8n-io/n8n.git
synced 2024-11-14 08:34:07 -08:00
1d27a9e87e
* Add path mapping and response error interfaces * Add error handling and throwing functionality * Refactor error handling into a single function * Re-implement error handling in Hacker News node * Fix linting details * Re-implement error handling in Spotify node * Re-implement error handling in G Suite Admin node * 🚧 create basic setup NodeError * 🚧 add httpCodes * 🚧 add path priolist * 🚧 handle statusCode in error, adjust interfaces * 🚧 fixing type issues w/Ivan * 🚧 add error exploration * 👔 fix linter issues * 🔧 improve object check * 🚧 remove path passing from NodeApiError * 🚧 add multi error + refactor findProperty method * 👔 allow any * 🔧 handle multi error message callback * ⚡ change return type of callback * ⚡ add customCallback to MultiError * 🚧 refactor to use INode * 🔨 handle arrays, continue search after first null property found * 🚫 refactor method access * 🚧 setup NodeErrorView * ⚡ change timestamp to Date.now * 📚 Add documentation for methods and constants * 🚧 change message setting * 🚚 move NodeErrors to workflow * ✨ add new ErrorView for Nodes * 🎨 improve error notification * 🎨 refactor interfaces * ⚡ add WorkflowOperationError, refactor error throwing * 👕 fix linter issues * 🎨 rename param * 🐛 fix handling normal errors * ⚡ add usage of NodeApiError * 🎨 fix throw new error instead of constructor * 🎨 remove unnecessary code/comments * 🎨 adjusted spacing + updated status messages * 🎨 fix tab indentation * ✨ Replace current errors with custom errors (#1576) * ⚡ Introduce NodeApiError in catch blocks * ⚡ Introduce NodeOperationError in nodes * ⚡ Add missing errors and remove incompatible * ⚡ Fix NodeOperationError in incompatible nodes * 🔧 Adjust error handling in missed nodes PayPal, FileMaker, Reddit, Taiga and Facebook Graph API nodes * 🔨 Adjust Strava Trigger node error handling * 🔨 Adjust AWS nodes error handling * 🔨 Remove duplicate instantiation of NodeApiError * 🐛 fix strava trigger node error handling * Add XML parsing to NodeApiError constructor (#1633) * 🐛 Remove type annotation from catch variable * ✨ Add XML parsing to NodeApiError * ⚡ Simplify error handling in Rekognition node * ⚡ Pass in XML flag in generic functions * 🔥 Remove try/catch wrappers at call sites * 🔨 Refactor setting description from XML * 🔨 Refactor let to const in resource loaders * ⚡ Find property in parsed XML * ⚡ Change let to const * 🔥 Remove unneeded try/catch block * 👕 Fix linting issues * 🐛 Fix errors from merge conflict resolution * ⚡ Add custom errors to latest contributions * 👕 Fix linting issues * ⚡ Refactor MongoDB helpers for custom errors * 🐛 Correct custom error type * ⚡ Apply feedback to A nodes * ⚡ Apply feedback to missed A node * ⚡ Apply feedback to B-D nodes * ⚡ Apply feedback to E-F nodes * ⚡ Apply feedback to G nodes * ⚡ Apply feedback to H-L nodes * ⚡ Apply feedback to M nodes * ⚡ Apply feedback to P nodes * ⚡ Apply feedback to R nodes * ⚡ Apply feedback to S nodes * ⚡ Apply feedback to T nodes * ⚡ Apply feedback to V-Z nodes * ⚡ Add HTTP code to iterable node error * 🔨 Standardize e as error * 🔨 Standardize err as error * ⚡ Fix error handling for non-standard nodes Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com> Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com> Co-authored-by: Ben Hesseldieck <1849459+BHesseldieck@users.noreply.github.com>
511 lines
14 KiB
TypeScript
511 lines
14 KiB
TypeScript
import {
|
|
IExecuteFunctions,
|
|
} from 'n8n-core';
|
|
|
|
import {
|
|
IDataObject,
|
|
ILoadOptionsFunctions,
|
|
INodeExecutionData,
|
|
INodeType,
|
|
INodeTypeDescription,
|
|
NodeOperationError,
|
|
} from 'n8n-workflow';
|
|
|
|
import {
|
|
bitwardenApiRequest as tokenlessBitwardenApiRequest,
|
|
getAccessToken,
|
|
handleGetAll as tokenlessHandleGetAll,
|
|
loadResource,
|
|
} from './GenericFunctions';
|
|
|
|
import {
|
|
collectionFields,
|
|
collectionOperations,
|
|
CollectionUpdateFields,
|
|
} from './descriptions/CollectionDescription';
|
|
|
|
import {
|
|
eventFields,
|
|
eventOperations,
|
|
} from './descriptions/EventDescription';
|
|
|
|
import {
|
|
GroupCreationAdditionalFields,
|
|
groupFields,
|
|
groupOperations,
|
|
GroupUpdateFields,
|
|
} from './descriptions/GroupDescription';
|
|
|
|
import {
|
|
MemberCreationAdditionalFields,
|
|
memberFields,
|
|
memberOperations,
|
|
MemberUpdateFields,
|
|
} from './descriptions/MemberDescription';
|
|
|
|
import {
|
|
isEmpty,
|
|
partialRight,
|
|
} from 'lodash';
|
|
|
|
export class Bitwarden implements INodeType {
|
|
description: INodeTypeDescription = {
|
|
displayName: 'Bitwarden',
|
|
name: 'bitwarden',
|
|
icon: 'file:bitwarden.svg',
|
|
group: ['transform'],
|
|
version: 1,
|
|
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
|
|
description: 'Consume the Bitwarden API',
|
|
defaults: {
|
|
name: 'Bitwarden',
|
|
color: '#175DDC',
|
|
},
|
|
inputs: ['main'],
|
|
outputs: ['main'],
|
|
credentials: [
|
|
{
|
|
name: 'bitwardenApi',
|
|
required: true,
|
|
},
|
|
],
|
|
properties: [
|
|
{
|
|
displayName: 'Resource',
|
|
name: 'resource',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'Collection',
|
|
value: 'collection',
|
|
},
|
|
{
|
|
name: 'Event',
|
|
value: 'event',
|
|
},
|
|
{
|
|
name: 'Group',
|
|
value: 'group',
|
|
},
|
|
{
|
|
name: 'Member',
|
|
value: 'member',
|
|
},
|
|
],
|
|
default: 'collection',
|
|
description: 'Resource to consume',
|
|
},
|
|
...collectionOperations,
|
|
...collectionFields,
|
|
...eventOperations,
|
|
...eventFields,
|
|
...groupOperations,
|
|
...groupFields,
|
|
...memberOperations,
|
|
...memberFields,
|
|
],
|
|
};
|
|
|
|
methods = {
|
|
loadOptions: {
|
|
async getGroups(this: ILoadOptionsFunctions) {
|
|
return await loadResource.call(this, 'groups');
|
|
},
|
|
|
|
async getCollections(this: ILoadOptionsFunctions) {
|
|
return await loadResource.call(this, 'collections');
|
|
},
|
|
},
|
|
};
|
|
|
|
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
|
|
const items = this.getInputData();
|
|
|
|
const resource = this.getNodeParameter('resource', 0) as string;
|
|
const operation = this.getNodeParameter('operation', 0) as string;
|
|
|
|
let responseData;
|
|
const returnData: IDataObject[] = [];
|
|
|
|
const token = await getAccessToken.call(this);
|
|
const bitwardenApiRequest = partialRight(tokenlessBitwardenApiRequest, token);
|
|
const handleGetAll = partialRight(tokenlessHandleGetAll, token);
|
|
|
|
for (let i = 0; i < items.length; i++) {
|
|
|
|
if (resource === 'collection') {
|
|
|
|
// *********************************************************************
|
|
// collection
|
|
// *********************************************************************
|
|
|
|
if (operation === 'delete') {
|
|
|
|
// ----------------------------------
|
|
// collection: delete
|
|
// ----------------------------------
|
|
|
|
const id = this.getNodeParameter('collectionId', i);
|
|
const endpoint = `/public/collections/${id}`;
|
|
responseData = await bitwardenApiRequest.call(this, 'DELETE', endpoint, {}, {});
|
|
responseData = { success: true };
|
|
|
|
} else if (operation === 'get') {
|
|
|
|
// ----------------------------------
|
|
// collection: get
|
|
// ----------------------------------
|
|
|
|
const id = this.getNodeParameter('collectionId', i);
|
|
const endpoint = `/public/collections/${id}`;
|
|
responseData = await bitwardenApiRequest.call(this, 'GET', endpoint, {}, {});
|
|
|
|
} else if (operation === 'getAll') {
|
|
|
|
// ----------------------------------
|
|
// collection: getAll
|
|
// ----------------------------------
|
|
|
|
const endpoint = '/public/collections';
|
|
responseData = await handleGetAll.call(this, i, 'GET', endpoint, {}, {});
|
|
|
|
} else if (operation === 'update') {
|
|
|
|
// ----------------------------------
|
|
// collection: update
|
|
// ----------------------------------
|
|
|
|
const updateFields = this.getNodeParameter('updateFields', i) as CollectionUpdateFields;
|
|
|
|
if (isEmpty(updateFields)) {
|
|
throw new NodeOperationError(this.getNode(), `Please enter at least one field to update for the ${resource}.`);
|
|
}
|
|
|
|
const { groups, externalId } = updateFields;
|
|
|
|
const body = {} as IDataObject;
|
|
|
|
if (groups) {
|
|
body.groups = groups.map((groupId) => ({
|
|
id: groupId,
|
|
ReadOnly: false,
|
|
}));
|
|
}
|
|
|
|
if (externalId) {
|
|
body.externalId = externalId;
|
|
}
|
|
|
|
const id = this.getNodeParameter('collectionId', i);
|
|
const endpoint = `/public/collections/${id}`;
|
|
responseData = await bitwardenApiRequest.call(this, 'PUT', endpoint, {}, body);
|
|
|
|
}
|
|
|
|
} else if (resource === 'event') {
|
|
|
|
// *********************************************************************
|
|
// event
|
|
// *********************************************************************
|
|
|
|
if (operation === 'getAll') {
|
|
|
|
// ----------------------------------
|
|
// event: getAll
|
|
// ----------------------------------
|
|
|
|
const filters = this.getNodeParameter('filters', i) as IDataObject;
|
|
const qs = isEmpty(filters) ? {} : filters;
|
|
const endpoint = '/public/events';
|
|
responseData = await handleGetAll.call(this, i, 'GET', endpoint, qs, {});
|
|
|
|
}
|
|
|
|
} else if (resource === 'group') {
|
|
|
|
// *********************************************************************
|
|
// group
|
|
// *********************************************************************
|
|
|
|
if (operation === 'create') {
|
|
|
|
// ----------------------------------
|
|
// group: create
|
|
// ----------------------------------
|
|
|
|
const body = {
|
|
name: this.getNodeParameter('name', i),
|
|
AccessAll: this.getNodeParameter('accessAll', i),
|
|
} as IDataObject;
|
|
|
|
const {
|
|
collections,
|
|
externalId,
|
|
} = this.getNodeParameter('additionalFields', i) as GroupCreationAdditionalFields;
|
|
|
|
if (collections) {
|
|
body.collections = collections.map((collectionId) => ({
|
|
id: collectionId,
|
|
ReadOnly: false,
|
|
}));
|
|
}
|
|
|
|
if (externalId) {
|
|
body.externalId = externalId;
|
|
}
|
|
|
|
const endpoint = '/public/groups';
|
|
responseData = await bitwardenApiRequest.call(this, 'POST', endpoint, {}, body);
|
|
|
|
} else if (operation === 'delete') {
|
|
|
|
// ----------------------------------
|
|
// group: delete
|
|
// ----------------------------------
|
|
|
|
const id = this.getNodeParameter('groupId', i);
|
|
const endpoint = `/public/groups/${id}`;
|
|
responseData = await bitwardenApiRequest.call(this, 'DELETE', endpoint, {}, {});
|
|
responseData = { success: true };
|
|
|
|
} else if (operation === 'get') {
|
|
|
|
// ----------------------------------
|
|
// group: get
|
|
// ----------------------------------
|
|
|
|
const id = this.getNodeParameter('groupId', i);
|
|
const endpoint = `/public/groups/${id}`;
|
|
responseData = await bitwardenApiRequest.call(this, 'GET', endpoint, {}, {});
|
|
|
|
} else if (operation === 'getAll') {
|
|
|
|
// ----------------------------------
|
|
// group: getAll
|
|
// ----------------------------------
|
|
|
|
const endpoint = '/public/groups';
|
|
responseData = await handleGetAll.call(this, i, 'GET', endpoint, {}, {});
|
|
|
|
} else if (operation === 'getMembers') {
|
|
|
|
// ----------------------------------
|
|
// group: getMembers
|
|
// ----------------------------------
|
|
|
|
const id = this.getNodeParameter('groupId', i);
|
|
const endpoint = `/public/groups/${id}/member-ids`;
|
|
responseData = await bitwardenApiRequest.call(this, 'GET', endpoint, {}, {});
|
|
responseData = responseData.map((memberId: string) => ({ memberId }));
|
|
|
|
} else if (operation === 'update') {
|
|
|
|
// ----------------------------------
|
|
// group: update
|
|
// ----------------------------------
|
|
|
|
const groupId = this.getNodeParameter('groupId', i);
|
|
|
|
const updateFields = this.getNodeParameter('updateFields', i) as GroupUpdateFields;
|
|
|
|
if (isEmpty(updateFields)) {
|
|
throw new NodeOperationError(this.getNode(), `Please enter at least one field to update for the ${resource}.`);
|
|
}
|
|
|
|
// set defaults for `name` and `accessAll`, required by Bitwarden but optional in n8n
|
|
|
|
let { name, accessAll } = updateFields;
|
|
|
|
if (name === undefined) {
|
|
responseData = await bitwardenApiRequest.call(this, 'GET', `/public/groups/${groupId}`, {}, {}) as { name: string };
|
|
name = responseData.name;
|
|
}
|
|
|
|
if (accessAll === undefined) {
|
|
accessAll = false;
|
|
}
|
|
|
|
const body = {
|
|
name,
|
|
AccessAll: accessAll,
|
|
} as IDataObject;
|
|
|
|
const { collections, externalId } = updateFields;
|
|
|
|
if (collections) {
|
|
body.collections = collections.map((collectionId) => ({
|
|
id: collectionId,
|
|
ReadOnly: false,
|
|
}));
|
|
}
|
|
|
|
if (externalId) {
|
|
body.externalId = externalId;
|
|
}
|
|
|
|
const endpoint = `/public/groups/${groupId}`;
|
|
responseData = await bitwardenApiRequest.call(this, 'PUT', endpoint, {}, body);
|
|
|
|
} else if (operation === 'updateMembers') {
|
|
|
|
// ----------------------------------
|
|
// group: updateMembers
|
|
// ----------------------------------
|
|
|
|
const memberIds = this.getNodeParameter('memberIds', i) as string;
|
|
|
|
const body = {
|
|
memberIds: memberIds.includes(',') ? memberIds.split(',') : [memberIds],
|
|
};
|
|
|
|
const groupId = this.getNodeParameter('groupId', i);
|
|
const endpoint = `/public/groups/${groupId}/member-ids`;
|
|
responseData = await bitwardenApiRequest.call(this, 'PUT', endpoint, {}, body);
|
|
responseData = { success: true };
|
|
}
|
|
|
|
} else if (resource === 'member') {
|
|
|
|
// *********************************************************************
|
|
// member
|
|
// *********************************************************************
|
|
|
|
if (operation === 'create') {
|
|
|
|
// ----------------------------------
|
|
// member: create
|
|
// ----------------------------------
|
|
|
|
const body = {
|
|
email: this.getNodeParameter('email', i),
|
|
type: this.getNodeParameter('type', i),
|
|
AccessAll: this.getNodeParameter('accessAll', i),
|
|
} as IDataObject;
|
|
|
|
const {
|
|
collections,
|
|
externalId,
|
|
} = this.getNodeParameter('additionalFields', i) as MemberCreationAdditionalFields;
|
|
|
|
if (collections) {
|
|
body.collections = collections.map((collectionId) => ({
|
|
id: collectionId,
|
|
ReadOnly: false,
|
|
}));
|
|
}
|
|
|
|
if (externalId) {
|
|
body.externalId = externalId;
|
|
}
|
|
|
|
const endpoint = '/public/members/';
|
|
responseData = await bitwardenApiRequest.call(this, 'POST', endpoint, {}, body);
|
|
|
|
} else if (operation === 'delete') {
|
|
|
|
// ----------------------------------
|
|
// member: delete
|
|
// ----------------------------------
|
|
|
|
const id = this.getNodeParameter('memberId', i);
|
|
const endpoint = `/public/members/${id}`;
|
|
responseData = await bitwardenApiRequest.call(this, 'DELETE', endpoint, {}, {});
|
|
responseData = { success: true };
|
|
|
|
} else if (operation === 'get') {
|
|
|
|
// ----------------------------------
|
|
// member: get
|
|
// ----------------------------------
|
|
|
|
const id = this.getNodeParameter('memberId', i);
|
|
const endpoint = `/public/members/${id}`;
|
|
responseData = await bitwardenApiRequest.call(this, 'GET', endpoint, {}, {});
|
|
|
|
} else if (operation === 'getAll') {
|
|
|
|
// ----------------------------------
|
|
// member: getAll
|
|
// ----------------------------------
|
|
|
|
const endpoint = '/public/members';
|
|
responseData = await handleGetAll.call(this, i, 'GET', endpoint, {}, {});
|
|
|
|
} else if (operation === 'getGroups') {
|
|
|
|
// ----------------------------------
|
|
// member: getGroups
|
|
// ----------------------------------
|
|
|
|
const id = this.getNodeParameter('memberId', i);
|
|
const endpoint = `/public/members/${id}/group-ids`;
|
|
responseData = await bitwardenApiRequest.call(this, 'GET', endpoint, {}, {});
|
|
responseData = responseData.map((groupId: string) => ({ groupId }));
|
|
|
|
} else if (operation === 'update') {
|
|
|
|
// ----------------------------------
|
|
// member: update
|
|
// ----------------------------------
|
|
|
|
const body = {} as IDataObject;
|
|
|
|
const updateFields = this.getNodeParameter('updateFields', i) as MemberUpdateFields;
|
|
|
|
if (isEmpty(updateFields)) {
|
|
throw new NodeOperationError(this.getNode(), `Please enter at least one field to update for the ${resource}.`);
|
|
}
|
|
|
|
const { accessAll, collections, externalId, type } = updateFields;
|
|
|
|
if (accessAll !== undefined) {
|
|
body.AccessAll = accessAll;
|
|
}
|
|
|
|
if (collections) {
|
|
body.collections = collections.map((collectionId) => ({
|
|
id: collectionId,
|
|
ReadOnly: false,
|
|
}));
|
|
}
|
|
|
|
if (externalId) {
|
|
body.externalId = externalId;
|
|
}
|
|
|
|
if (type !== undefined) {
|
|
body.Type = type;
|
|
}
|
|
|
|
const id = this.getNodeParameter('memberId', i);
|
|
const endpoint = `/public/members/${id}`;
|
|
responseData = await bitwardenApiRequest.call(this, 'PUT', endpoint, {}, body);
|
|
|
|
} else if (operation === 'updateGroups') {
|
|
|
|
// ----------------------------------
|
|
// member: updateGroups
|
|
// ----------------------------------
|
|
|
|
const groupIds = this.getNodeParameter('groupIds', i) as string;
|
|
|
|
const body = {
|
|
groupIds: groupIds.includes(',') ? groupIds.split(',') : [groupIds],
|
|
};
|
|
|
|
const memberId = this.getNodeParameter('memberId', i);
|
|
const endpoint = `/public/members/${memberId}/group-ids`;
|
|
responseData = await bitwardenApiRequest.call(this, 'PUT', endpoint, {}, body);
|
|
responseData = { success: true };
|
|
}
|
|
}
|
|
|
|
Array.isArray(responseData)
|
|
? returnData.push(...responseData)
|
|
: returnData.push(responseData);
|
|
}
|
|
|
|
return [this.helpers.returnJsonArray(returnData)];
|
|
}
|
|
}
|