mirror of
https://github.com/n8n-io/n8n.git
synced 2024-12-26 21:19:43 -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>
354 lines
9.1 KiB
TypeScript
354 lines
9.1 KiB
TypeScript
import {
|
|
IExecuteFunctions,
|
|
} from 'n8n-core';
|
|
|
|
import {
|
|
IDataObject,
|
|
ILoadOptionsFunctions,
|
|
INodeExecutionData,
|
|
INodePropertyOptions,
|
|
INodeType,
|
|
INodeTypeDescription,
|
|
NodeOperationError,
|
|
} from 'n8n-workflow';
|
|
|
|
import {
|
|
ghostApiRequest,
|
|
ghostApiRequestAllItems,
|
|
validateJSON,
|
|
} from './GenericFunctions';
|
|
|
|
import {
|
|
postFields,
|
|
postOperations,
|
|
} from './PostDescription';
|
|
|
|
import * as moment from 'moment-timezone';
|
|
|
|
export class Ghost implements INodeType {
|
|
description: INodeTypeDescription = {
|
|
displayName: 'Ghost',
|
|
name: 'ghost',
|
|
icon: 'file:ghost.png',
|
|
group: ['input'],
|
|
version: 1,
|
|
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
|
|
description: 'Consume Ghost API.',
|
|
defaults: {
|
|
name: 'Ghost',
|
|
color: '#15212a',
|
|
},
|
|
inputs: ['main'],
|
|
outputs: ['main'],
|
|
credentials: [
|
|
{
|
|
name: 'ghostAdminApi',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
source: [
|
|
'adminApi',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: 'ghostContentApi',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
source: [
|
|
'contentApi',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
],
|
|
properties: [
|
|
{
|
|
displayName: 'Source',
|
|
name: 'source',
|
|
type: 'options',
|
|
description: 'Pick where your data comes from, Content or Admin API',
|
|
options: [
|
|
{
|
|
name: 'Admin API',
|
|
value: 'adminApi',
|
|
},
|
|
{
|
|
name: 'Content API',
|
|
value: 'contentApi',
|
|
},
|
|
],
|
|
default: 'contentApi',
|
|
},
|
|
{
|
|
displayName: 'Resource',
|
|
name: 'resource',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'Post',
|
|
value: 'post',
|
|
},
|
|
],
|
|
default: 'post',
|
|
description: 'The resource to operate on.',
|
|
},
|
|
...postOperations,
|
|
...postFields,
|
|
],
|
|
};
|
|
|
|
|
|
methods = {
|
|
loadOptions: {
|
|
// Get all the authors to display them to user so that he can
|
|
// select them easily
|
|
async getAuthors(
|
|
this: ILoadOptionsFunctions,
|
|
): Promise<INodePropertyOptions[]> {
|
|
const returnData: INodePropertyOptions[] = [];
|
|
const users = await ghostApiRequestAllItems.call(
|
|
this,
|
|
'users',
|
|
'GET',
|
|
`/admin/users`,
|
|
);
|
|
for (const user of users) {
|
|
returnData.push({
|
|
name: user.name,
|
|
value: user.id,
|
|
});
|
|
}
|
|
return returnData;
|
|
},
|
|
// Get all the tags to display them to user so that he can
|
|
// select them easily
|
|
async getTags(
|
|
this: ILoadOptionsFunctions,
|
|
): Promise<INodePropertyOptions[]> {
|
|
const returnData: INodePropertyOptions[] = [];
|
|
const tags = await ghostApiRequestAllItems.call(
|
|
this,
|
|
'tags',
|
|
'GET',
|
|
`/admin/tags`,
|
|
);
|
|
for (const tag of tags) {
|
|
returnData.push({
|
|
name: tag.name,
|
|
value: tag.id,
|
|
});
|
|
}
|
|
return returnData;
|
|
},
|
|
},
|
|
};
|
|
|
|
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
|
|
const items = this.getInputData();
|
|
const returnData: IDataObject[] = [];
|
|
const length = (items.length as unknown) as number;
|
|
const timezone = this.getTimezone();
|
|
const qs: IDataObject = {};
|
|
let responseData;
|
|
const resource = this.getNodeParameter('resource', 0) as string;
|
|
const operation = this.getNodeParameter('operation', 0) as string;
|
|
const source = this.getNodeParameter('source', 0) as string;
|
|
|
|
if (source === 'contentApi') {
|
|
if (resource === 'post') {
|
|
if (operation === 'get') {
|
|
for (let i = 0; i < items.length; i++) {
|
|
const by = this.getNodeParameter('by', i) as string;
|
|
|
|
const identifier = this.getNodeParameter('identifier', i) as string;
|
|
|
|
const options = this.getNodeParameter('options', i) as IDataObject;
|
|
|
|
Object.assign(qs, options);
|
|
|
|
let endpoint;
|
|
|
|
if (by === 'slug') {
|
|
endpoint = `/content/posts/slug/${identifier}`;
|
|
} else {
|
|
endpoint = `/content/posts/${identifier}`;
|
|
}
|
|
responseData = await ghostApiRequest.call(this, 'GET', endpoint, {}, qs);
|
|
|
|
returnData.push.apply(returnData, responseData.posts);
|
|
}
|
|
}
|
|
|
|
if (operation === 'getAll') {
|
|
for (let i = 0; i < items.length; i++) {
|
|
|
|
const returnAll = this.getNodeParameter('returnAll', 0) as boolean;
|
|
|
|
const options = this.getNodeParameter('options', i) as IDataObject;
|
|
|
|
Object.assign(qs, options);
|
|
|
|
if (returnAll) {
|
|
responseData = await ghostApiRequestAllItems.call(this, 'posts', 'GET', '/content/posts', {} ,qs);
|
|
} else {
|
|
qs.limit = this.getNodeParameter('limit', 0);
|
|
responseData = await ghostApiRequest.call(this, 'GET', '/content/posts', {}, qs);
|
|
responseData = responseData.posts;
|
|
}
|
|
|
|
returnData.push.apply(returnData, responseData);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if (source === 'adminApi') {
|
|
if (resource === 'post') {
|
|
if (operation === 'create') {
|
|
for (let i = 0; i < length; i++) {
|
|
const title = this.getNodeParameter('title', i) as string;
|
|
|
|
const contentFormat = this.getNodeParameter('contentFormat', i) as string;
|
|
|
|
const content = this.getNodeParameter('content', i) as string;
|
|
|
|
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
|
|
|
const post: IDataObject = {
|
|
title,
|
|
};
|
|
|
|
if (contentFormat === 'html') {
|
|
post.html = content;
|
|
qs.source = 'html';
|
|
} else {
|
|
const mobileDoc = validateJSON(content);
|
|
if (mobileDoc === undefined) {
|
|
throw new NodeOperationError(this.getNode(), 'Content must be a valid JSON');
|
|
}
|
|
post.mobiledoc = content;
|
|
}
|
|
|
|
delete post.content;
|
|
|
|
Object.assign(post, additionalFields);
|
|
|
|
if (post.published_at) {
|
|
post.published_at = moment.tz(post.published_at, timezone).utc().format();
|
|
}
|
|
|
|
if (post.status === 'scheduled' && post.published_at === undefined) {
|
|
throw new NodeOperationError(this.getNode(), 'Published at must be define when status is scheduled');
|
|
}
|
|
|
|
responseData = await ghostApiRequest.call(this, 'POST', '/admin/posts', { posts: [post] }, qs);
|
|
|
|
returnData.push.apply(returnData, responseData.posts);
|
|
}
|
|
}
|
|
|
|
if (operation === 'delete') {
|
|
for (let i = 0; i < length; i++) {
|
|
const postId = this.getNodeParameter('postId', i) as string;
|
|
|
|
responseData = await ghostApiRequest.call(this, 'DELETE', `/admin/posts/${postId}`);
|
|
|
|
returnData.push({ success: true });
|
|
}
|
|
}
|
|
|
|
if (operation === 'get') {
|
|
for (let i = 0; i < length; i++) {
|
|
const by = this.getNodeParameter('by', i) as string;
|
|
|
|
const identifier = this.getNodeParameter('identifier', i) as string;
|
|
|
|
const options = this.getNodeParameter('options', i) as IDataObject;
|
|
|
|
Object.assign(qs, options);
|
|
|
|
let endpoint;
|
|
|
|
if (by === 'slug') {
|
|
endpoint = `/admin/posts/slug/${identifier}`;
|
|
} else {
|
|
endpoint = `/admin/posts/${identifier}`;
|
|
}
|
|
responseData = await ghostApiRequest.call(this, 'GET', endpoint, {}, qs);
|
|
|
|
returnData.push.apply(returnData, responseData.posts);
|
|
}
|
|
}
|
|
|
|
if (operation === 'getAll') {
|
|
for (let i = 0; i < length; i++) {
|
|
|
|
const returnAll = this.getNodeParameter('returnAll', 0) as boolean;
|
|
|
|
const options = this.getNodeParameter('options', i) as IDataObject;
|
|
|
|
Object.assign(qs, options);
|
|
|
|
if (returnAll) {
|
|
responseData = await ghostApiRequestAllItems.call(this, 'posts', 'GET', '/admin/posts', {} ,qs);
|
|
} else {
|
|
qs.limit = this.getNodeParameter('limit', 0);
|
|
responseData = await ghostApiRequest.call(this, 'GET', '/admin/posts', {}, qs);
|
|
responseData = responseData.posts;
|
|
}
|
|
|
|
returnData.push.apply(returnData, responseData);
|
|
}
|
|
}
|
|
|
|
if (operation === 'update') {
|
|
for (let i = 0; i < length; i++) {
|
|
const postId = this.getNodeParameter('postId', i) as string;
|
|
|
|
const contentFormat = this.getNodeParameter('contentFormat', i) as string;
|
|
|
|
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
|
|
|
|
const post: IDataObject = {};
|
|
|
|
if (contentFormat === 'html') {
|
|
post.html = updateFields.content || '';
|
|
qs.source = 'html';
|
|
delete updateFields.content;
|
|
} else {
|
|
const mobileDoc = validateJSON(updateFields.contentJson as string || undefined);
|
|
if (mobileDoc === undefined) {
|
|
throw new NodeOperationError(this.getNode(), 'Content must be a valid JSON');
|
|
}
|
|
post.mobiledoc = updateFields.contentJson;
|
|
delete updateFields.contentJson;
|
|
}
|
|
|
|
Object.assign(post, updateFields);
|
|
|
|
const { posts } = await ghostApiRequest.call(this, 'GET', `/admin/posts/${postId}`, {}, { fields: 'id, updated_at' });
|
|
|
|
if (post.published_at) {
|
|
post.published_at = moment.tz(post.published_at, timezone).utc().format();
|
|
}
|
|
|
|
if (post.status === 'scheduled' && post.published_at === undefined) {
|
|
throw new NodeOperationError(this.getNode(), 'Published at must be define when status is scheduled');
|
|
}
|
|
|
|
post.updated_at = posts[0].updated_at;
|
|
|
|
responseData = await ghostApiRequest.call(this, 'PUT', `/admin/posts/${postId}`, { posts: [post] }, qs);
|
|
|
|
returnData.push.apply(returnData, responseData.posts);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return [this.helpers.returnJsonArray(returnData)];
|
|
}
|
|
}
|