mirror of
https://github.com/n8n-io/n8n.git
synced 2024-12-26 13:14: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>
462 lines
11 KiB
TypeScript
462 lines
11 KiB
TypeScript
import {
|
|
IExecuteFunctions,
|
|
} from 'n8n-core';
|
|
|
|
import {
|
|
IDataObject,
|
|
ILoadOptionsFunctions,
|
|
INodeExecutionData,
|
|
INodePropertyOptions,
|
|
INodeType,
|
|
INodeTypeDescription,
|
|
NodeOperationError,
|
|
} from 'n8n-workflow';
|
|
|
|
import {
|
|
googleApiRequest,
|
|
googleApiRequestAllItems,
|
|
} from './GenericFunctions';
|
|
|
|
import {
|
|
userFields,
|
|
userOperations,
|
|
} from './UserDescription';
|
|
|
|
import {
|
|
groupFields,
|
|
groupOperations,
|
|
} from './GroupDescripion';
|
|
|
|
export class GSuiteAdmin implements INodeType {
|
|
description: INodeTypeDescription = {
|
|
displayName: 'G Suite Admin',
|
|
name: 'gSuiteAdmin',
|
|
icon: 'file:gSuiteAdmin.png',
|
|
group: ['input'],
|
|
version: 1,
|
|
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
|
|
description: 'Consume G Suite Admin API',
|
|
defaults: {
|
|
name: 'G Suite Admin',
|
|
color: '#ecbb26',
|
|
},
|
|
inputs: ['main'],
|
|
outputs: ['main'],
|
|
credentials: [
|
|
{
|
|
name: 'gSuiteAdminOAuth2Api',
|
|
required: true,
|
|
},
|
|
],
|
|
properties: [
|
|
{
|
|
displayName: 'Resource',
|
|
name: 'resource',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'Group',
|
|
value: 'group',
|
|
},
|
|
{
|
|
name: 'User',
|
|
value: 'user',
|
|
},
|
|
],
|
|
default: 'user',
|
|
description: 'The resource to operate on.',
|
|
},
|
|
...groupOperations,
|
|
...groupFields,
|
|
...userOperations,
|
|
...userFields,
|
|
],
|
|
};
|
|
|
|
methods = {
|
|
loadOptions: {
|
|
// Get all the domains to display them to user so that he can
|
|
// select them easily
|
|
async getDomains(
|
|
this: ILoadOptionsFunctions,
|
|
): Promise<INodePropertyOptions[]> {
|
|
const returnData: INodePropertyOptions[] = [];
|
|
const domains = await googleApiRequestAllItems.call(
|
|
this,
|
|
'domains',
|
|
'GET',
|
|
'/directory/v1/customer/my_customer/domains',
|
|
);
|
|
for (const domain of domains) {
|
|
const domainName = domain.domainName;
|
|
const domainId = domain.domainName;
|
|
returnData.push({
|
|
name: domainName,
|
|
value: domainId,
|
|
});
|
|
}
|
|
return returnData;
|
|
},
|
|
// Get all the schemas to display them to user so that he can
|
|
// select them easily
|
|
async getSchemas(
|
|
this: ILoadOptionsFunctions,
|
|
): Promise<INodePropertyOptions[]> {
|
|
const returnData: INodePropertyOptions[] = [];
|
|
const schemas = await googleApiRequestAllItems.call(
|
|
this,
|
|
'schemas',
|
|
'GET',
|
|
'/directory/v1/customer/my_customer/schemas',
|
|
);
|
|
for (const schema of schemas) {
|
|
const schemaName = schema.displayName;
|
|
const schemaId = schema.schemaName;
|
|
returnData.push({
|
|
name: schemaName,
|
|
value: schemaId,
|
|
});
|
|
}
|
|
return returnData;
|
|
},
|
|
},
|
|
};
|
|
|
|
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
|
|
const items = this.getInputData();
|
|
const returnData: IDataObject[] = [];
|
|
const length = (items.length as unknown) as number;
|
|
const qs: IDataObject = {};
|
|
let responseData;
|
|
const resource = this.getNodeParameter('resource', 0) as string;
|
|
const operation = this.getNodeParameter('operation', 0) as string;
|
|
for (let i = 0; i < length; i++) {
|
|
if (resource === 'group') {
|
|
//https://developers.google.com/admin-sdk/directory/v1/reference/groups/insert
|
|
if (operation === 'create') {
|
|
const email = this.getNodeParameter('email', i) as string;
|
|
|
|
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
|
|
|
const body: IDataObject = {
|
|
email,
|
|
};
|
|
|
|
Object.assign(body, additionalFields);
|
|
|
|
responseData = await googleApiRequest.call(
|
|
this,
|
|
'POST',
|
|
`/directory/v1/groups`,
|
|
body,
|
|
);
|
|
}
|
|
|
|
//https://developers.google.com/admin-sdk/directory/v1/reference/groups/delete
|
|
if (operation === 'delete') {
|
|
const groupId = this.getNodeParameter('groupId', i) as string;
|
|
|
|
responseData = await googleApiRequest.call(
|
|
this,
|
|
'DELETE',
|
|
`/directory/v1/groups/${groupId}`,
|
|
{},
|
|
);
|
|
|
|
responseData = { success: true };
|
|
}
|
|
|
|
//https://developers.google.com/admin-sdk/directory/v1/reference/groups/get
|
|
if (operation === 'get') {
|
|
const groupId = this.getNodeParameter('groupId', i) as string;
|
|
|
|
responseData = await googleApiRequest.call(
|
|
this,
|
|
'GET',
|
|
`/directory/v1/groups/${groupId}`,
|
|
{},
|
|
);
|
|
}
|
|
|
|
//https://developers.google.com/admin-sdk/directory/v1/reference/groups/list
|
|
if (operation === 'getAll') {
|
|
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
|
|
|
|
const options = this.getNodeParameter('options', i) as IDataObject;
|
|
|
|
Object.assign(qs, options);
|
|
|
|
if (qs.customer === undefined) {
|
|
qs.customer = 'my_customer';
|
|
}
|
|
|
|
if (returnAll) {
|
|
responseData = await googleApiRequestAllItems.call(
|
|
this,
|
|
'groups',
|
|
'GET',
|
|
`/directory/v1/groups`,
|
|
{},
|
|
qs,
|
|
);
|
|
|
|
} else {
|
|
qs.maxResults = this.getNodeParameter('limit', i) as number;
|
|
|
|
responseData = await googleApiRequest.call(
|
|
this,
|
|
'GET',
|
|
`/directory/v1/groups`,
|
|
{},
|
|
qs,
|
|
);
|
|
|
|
responseData = responseData.groups;
|
|
}
|
|
}
|
|
|
|
//https://developers.google.com/admin-sdk/directory/v1/reference/groups/update
|
|
if (operation === 'update') {
|
|
const groupId = this.getNodeParameter('groupId', i) as string;
|
|
|
|
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
|
|
|
|
const body: IDataObject = {};
|
|
|
|
Object.assign(body, updateFields);
|
|
|
|
responseData = await googleApiRequest.call(
|
|
this,
|
|
'PUT',
|
|
`/directory/v1/groups/${groupId}`,
|
|
body,
|
|
);
|
|
}
|
|
}
|
|
|
|
if (resource === 'user') {
|
|
//https://developers.google.com/admin-sdk/directory/v1/reference/users/insert
|
|
if (operation === 'create') {
|
|
const domain = this.getNodeParameter('domain', i) as string;
|
|
|
|
const firstName = this.getNodeParameter('firstName', i) as string;
|
|
|
|
const lastName = this.getNodeParameter('lastName', i) as string;
|
|
|
|
const password = this.getNodeParameter('password', i) as string;
|
|
|
|
const username = this.getNodeParameter('username', i) as string;
|
|
|
|
const makeAdmin = this.getNodeParameter('makeAdmin', i) as boolean;
|
|
|
|
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
|
|
|
const body: IDataObject = {
|
|
name: {
|
|
familyName: lastName,
|
|
givenName: firstName,
|
|
},
|
|
password,
|
|
primaryEmail: `${username}@${domain}`,
|
|
};
|
|
|
|
Object.assign(body, additionalFields);
|
|
|
|
if (additionalFields.phoneUi) {
|
|
const phones = (additionalFields.phoneUi as IDataObject).phoneValues as IDataObject[];
|
|
|
|
body.phones = phones;
|
|
|
|
delete body.phoneUi;
|
|
}
|
|
|
|
if (additionalFields.emailUi) {
|
|
const emails = (additionalFields.emailUi as IDataObject).emailValues as IDataObject[];
|
|
|
|
body.emails = emails;
|
|
|
|
delete body.emailUi;
|
|
}
|
|
|
|
responseData = await googleApiRequest.call(
|
|
this,
|
|
'POST',
|
|
`/directory/v1/users`,
|
|
body,
|
|
qs,
|
|
);
|
|
|
|
if (makeAdmin) {
|
|
await googleApiRequest.call(
|
|
this,
|
|
'POST',
|
|
`/directory/v1/users/${responseData.id}/makeAdmin`,
|
|
{ status: true },
|
|
);
|
|
|
|
responseData.isAdmin = true;
|
|
}
|
|
}
|
|
|
|
//https://developers.google.com/admin-sdk/directory/v1/reference/users/delete
|
|
if (operation === 'delete') {
|
|
const userId = this.getNodeParameter('userId', i) as string;
|
|
|
|
responseData = await googleApiRequest.call(
|
|
this,
|
|
'DELETE',
|
|
`/directory/v1/users/${userId}`,
|
|
{},
|
|
);
|
|
|
|
responseData = { success: true };
|
|
}
|
|
|
|
//https://developers.google.com/admin-sdk/directory/v1/reference/users/get
|
|
if (operation === 'get') {
|
|
const userId = this.getNodeParameter('userId', i) as string;
|
|
|
|
const projection = this.getNodeParameter('projection', i) as string;
|
|
|
|
const options = this.getNodeParameter('options', i) as IDataObject;
|
|
|
|
qs.projection = projection;
|
|
|
|
Object.assign(qs, options);
|
|
|
|
if (qs.customFieldMask) {
|
|
qs.customFieldMask = (qs.customFieldMask as string[]).join(' ');
|
|
}
|
|
|
|
if (qs.projection === 'custom' && qs.customFieldMask === undefined) {
|
|
throw new NodeOperationError(this.getNode(), 'When projection is set to custom, the custom schemas field must be defined');
|
|
}
|
|
|
|
responseData = await googleApiRequest.call(
|
|
this,
|
|
'GET',
|
|
`/directory/v1/users/${userId}`,
|
|
{},
|
|
qs,
|
|
);
|
|
}
|
|
|
|
//https://developers.google.com/admin-sdk/directory/v1/reference/users/list
|
|
if (operation === 'getAll') {
|
|
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
|
|
|
|
const projection = this.getNodeParameter('projection', i) as string;
|
|
|
|
const options = this.getNodeParameter('options', i) as IDataObject;
|
|
|
|
qs.projection = projection;
|
|
|
|
Object.assign(qs, options);
|
|
|
|
if (qs.customer === undefined) {
|
|
qs.customer = 'my_customer';
|
|
}
|
|
|
|
if (qs.customFieldMask) {
|
|
qs.customFieldMask = (qs.customFieldMask as string[]).join(' ');
|
|
}
|
|
|
|
if (qs.projection === 'custom' && qs.customFieldMask === undefined) {
|
|
throw new NodeOperationError(this.getNode(), 'When projection is set to custom, the custom schemas field must be defined');
|
|
}
|
|
|
|
if (returnAll) {
|
|
responseData = await googleApiRequestAllItems.call(
|
|
this,
|
|
'users',
|
|
'GET',
|
|
`/directory/v1/users`,
|
|
{},
|
|
qs,
|
|
);
|
|
|
|
} else {
|
|
qs.maxResults = this.getNodeParameter('limit', i) as number;
|
|
|
|
responseData = await googleApiRequest.call(
|
|
this,
|
|
'GET',
|
|
`/directory/v1/users`,
|
|
{},
|
|
qs,
|
|
);
|
|
|
|
responseData = responseData.users;
|
|
}
|
|
}
|
|
|
|
//https://developers.google.com/admin-sdk/directory/v1/reference/users/update
|
|
if (operation === 'update') {
|
|
const userId = this.getNodeParameter('userId', i) as string;
|
|
|
|
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
|
|
|
|
const body: { name: { givenName?: string, familyName?: string }, emails?: IDataObject[], phones?: IDataObject[] } = { name: {} };
|
|
|
|
Object.assign(body, updateFields);
|
|
|
|
if (updateFields.firstName) {
|
|
body.name.givenName = updateFields.firstName as string;
|
|
//@ts-ignore
|
|
delete body.firstName;
|
|
}
|
|
|
|
if (updateFields.lastName) {
|
|
body.name.familyName = updateFields.lastName as string;
|
|
//@ts-ignore
|
|
delete body.lastName;
|
|
}
|
|
|
|
if (Object.keys(body.name).length === 0) {
|
|
//@ts-ignore
|
|
delete body.name;
|
|
}
|
|
|
|
if (updateFields.phoneUi) {
|
|
const phones = (updateFields.phoneUi as IDataObject).phoneValues as IDataObject[];
|
|
|
|
body.phones = phones;
|
|
|
|
//@ts-ignore
|
|
delete body.phoneUi;
|
|
}
|
|
|
|
if (updateFields.emailUi) {
|
|
const emails = (updateFields.emailUi as IDataObject).emailValues as IDataObject[];
|
|
|
|
body.emails = emails;
|
|
|
|
//@ts-ignore
|
|
delete body.emailUi;
|
|
}
|
|
|
|
//@ts-ignore
|
|
body['customSchemas'] = { testing: { hasdog: true } };
|
|
|
|
responseData = await googleApiRequest.call(
|
|
this,
|
|
'PUT',
|
|
`/directory/v1/users/${userId}`,
|
|
body,
|
|
qs,
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
if (Array.isArray(responseData)) {
|
|
returnData.push.apply(returnData, responseData as IDataObject[]);
|
|
|
|
} else if (responseData !== undefined) {
|
|
returnData.push(responseData as IDataObject);
|
|
}
|
|
|
|
return [this.helpers.returnJsonArray(returnData)];
|
|
}
|
|
}
|