Initial commit to release

packages/editor-ui/src/components/mixins/restApi.ts

@@ -0,0 +1,292 @@
+import Vue from 'vue';
+import { parse } from 'flatted';
+
+import axios, { AxiosRequestConfig } from 'axios';
+import {
+	IActivationError,
+	ICredentialsDecryptedResponse,
+	ICredentialsResponse,
+	IExecutionsCurrentSummaryExtended,
+	IExecutionDeleteFilter,
+	IExecutionPushResponse,
+	IExecutionResponse,
+	IExecutionFlattedResponse,
+	IExecutionsListResponse,
+	IExecutionsStopData,
+	IN8nUISettings,
+	IStartRunData,
+	IWorkflowDb,
+	IWorkflowShortResponse,
+	IRestApi,
+	IWorkflowData,
+	IWorkflowDataUpdate,
+} from '@/Interface';
+import {
+	ICredentialsDecrypted,
+	ICredentialType,
+	IDataObject,
+	INodeCredentials,
+	INodePropertyOptions,
+	INodeTypeDescription,
+} from 'n8n-workflow';
+
+/**
+ * Unflattens the Execution data.
+ *
+ * @export
+ * @param {IExecutionFlattedResponse} fullExecutionData The data to unflatten
+ * @returns {IExecutionResponse}
+ */
+function unflattenExecutionData (fullExecutionData: IExecutionFlattedResponse): IExecutionResponse {
+	// Unflatten the data
+	const returnData: IExecutionResponse = {
+		...fullExecutionData,
+		workflowData: fullExecutionData.workflowData as IWorkflowDb,
+		data: parse(fullExecutionData.data),
+	};
+
+	returnData.finished = returnData.finished ? returnData.finished : false;
+
+	if (fullExecutionData.id) {
+		returnData.id = fullExecutionData.id;
+	}
+
+	return returnData;
+}
+
+export class ReponseError extends Error {
+	// The HTTP status code of response
+	httpStatusCode?: number;
+
+	// The error code in the resonse
+	errorCode?: number;
+
+	// The stack trace of the server
+	serverStackTrace?: string;
+
+	/**
+	 * Creates an instance of ReponseError.
+	 * @param {string} message The error message
+	 * @param {number} [errorCode] The error code which can be used by frontend to identify the actual error
+	 * @param {number} [httpStatusCode] The HTTP status code the response should have
+	 * @param {string} [stack] The stack trace
+	 * @memberof ReponseError
+	 */
+	constructor (message: string, errorCode?: number, httpStatusCode?: number, stack?: string) {
+		super(message);
+		this.name = 'ReponseError';
+
+		if (errorCode) {
+			this.errorCode = errorCode;
+		}
+		if (httpStatusCode) {
+			this.httpStatusCode = httpStatusCode;
+		}
+		if (stack) {
+			this.serverStackTrace = stack;
+		}
+	}
+}
+
+export const restApi = Vue.extend({
+	methods: {
+		restApi (): IRestApi {
+			const self = this;
+			return {
+				async makeRestApiRequest (method: string, endpoint: string, data?: IDataObject): Promise<any> { // tslint:disable-line:no-any
+					try {
+						const options: AxiosRequestConfig = {
+							method,
+							url: endpoint,
+							baseURL: self.$store.getters.getRestUrl,
+							headers: {
+								sessionid: self.$store.getters.sessionId,
+							},
+						};
+						if (['PATCH', 'POST', 'PUT'].includes(method)) {
+							options.data = data;
+						} else {
+							options.params = data;
+						}
+
+						const response = await axios.request(options);
+						return response.data.data;
+					} catch (error) {
+						if (error.message === 'Network Error') {
+							throw new ReponseError('API-Server can not be reached. It is probably down.');
+						}
+
+						const errorResponseData = error.response.data;
+						if (errorResponseData !== undefined && errorResponseData.message !== undefined) {
+							throw new ReponseError(errorResponseData.message, errorResponseData.code, error.response.status, errorResponseData.stack);
+						}
+
+						throw error;
+					}
+				},
+				getActiveWorkflows: (): Promise<string[]> => {
+					return self.restApi().makeRestApiRequest('GET', `/active`);
+				},
+				getActivationError: (id: string): Promise<IActivationError | undefined> => {
+					return self.restApi().makeRestApiRequest('GET', `/active/error/${id}`);
+				},
+				getCurrentExecutions: (filter: object): Promise<IExecutionsCurrentSummaryExtended[]> => {
+					let sendData = {};
+					if (filter) {
+						sendData = {
+							filter,
+						};
+					}
+					return self.restApi().makeRestApiRequest('GET', `/executions-current`, sendData);
+				},
+				stopCurrentExecution: (executionId: string): Promise<IExecutionsStopData> => {
+					return self.restApi().makeRestApiRequest('POST', `/executions-current/${executionId}/stop`);
+				},
+				getSettings: (): Promise<IN8nUISettings> => {
+					return self.restApi().makeRestApiRequest('GET', `/settings`);
+				},
+
+				// Returns all node-types
+				getNodeTypes: (): Promise<INodeTypeDescription[]> => {
+					return self.restApi().makeRestApiRequest('GET', `/node-types`);
+				},
+
+				// Returns all the parameter options from the server
+				getNodeParameterOptions: (nodeType: string, methodName: string, credentials?: INodeCredentials): Promise<INodePropertyOptions[]> => {
+					const sendData = {
+						nodeType,
+						methodName,
+						credentials,
+					};
+
+					return self.restApi().makeRestApiRequest('GET', '/node-parameter-options', sendData);
+				},
+
+				// Removes a test webhook
+				removeTestWebhook: (workflowId: string): Promise<boolean> => {
+					return self.restApi().makeRestApiRequest('DELETE', `/test-webhook/${workflowId}`);
+				},
+
+				// Execute a workflow
+				runWorkflow: async (startRunData: IStartRunData): Promise<IExecutionPushResponse> => {
+					return self.restApi().makeRestApiRequest('POST', `/workflows/run`, startRunData);
+				},
+
+				// Creates new credentials
+				createNewWorkflow: (sendData: IWorkflowData): Promise<IWorkflowDb> => {
+					return self.restApi().makeRestApiRequest('POST', `/workflows`, sendData);
+				},
+
+				// Updates an existing workflow
+				updateWorkflow: (id: string, data: IWorkflowDataUpdate): Promise<IWorkflowDb> => {
+					return self.restApi().makeRestApiRequest('PATCH', `/workflows/${id}`, data);
+				},
+
+				// Deletes a workflow
+				deleteWorkflow: (name: string): Promise<void> => {
+					return self.restApi().makeRestApiRequest('DELETE', `/workflows/${name}`);
+				},
+
+				// Returns the workflow with the given name
+				getWorkflow: (id: string): Promise<IWorkflowDb> => {
+					return self.restApi().makeRestApiRequest('GET', `/workflows/${id}`);
+				},
+
+				// Returns all saved workflows
+				getWorkflows: (filter?: object): Promise<IWorkflowShortResponse[]> => {
+					let sendData;
+					if (filter) {
+						sendData = {
+							filter,
+						};
+					}
+					return self.restApi().makeRestApiRequest('GET', `/workflows`, sendData);
+				},
+
+				// Returns a workflow from a given URL
+				getWorkflowFromUrl: (url: string): Promise<IWorkflowDb> => {
+					return self.restApi().makeRestApiRequest('GET', `/workflows/from-url`, { url });
+				},
+
+				// Creates a new workflow
+				createNewCredentials: (sendData: ICredentialsDecrypted): Promise<ICredentialsResponse> => {
+					return self.restApi().makeRestApiRequest('POST', `/credentials`, sendData);
+				},
+
+				// Deletes a credentials
+				deleteCredentials: (id: string): Promise<void> => {
+					return self.restApi().makeRestApiRequest('DELETE', `/credentials/${id}`);
+				},
+
+				// Updates existing credentials
+				updateCredentials: (id: string, data: ICredentialsDecrypted): Promise<ICredentialsResponse> => {
+					return self.restApi().makeRestApiRequest('PATCH', `/credentials/${id}`, data);
+				},
+
+				// Returns the credentials with the given id
+				getCredentials: (id: string, includeData?: boolean): Promise<ICredentialsDecryptedResponse | ICredentialsResponse | undefined> => {
+					let sendData;
+					if (includeData) {
+						sendData = {
+							includeData,
+						};
+					}
+					return self.restApi().makeRestApiRequest('GET', `/credentials/${id}`, sendData);
+				},
+
+				// Returns all saved credentials
+				getAllCredentials: (filter?: object): Promise<ICredentialsResponse[]> => {
+					let sendData;
+					if (filter) {
+						sendData = {
+							filter,
+						};
+					}
+
+					return self.restApi().makeRestApiRequest('GET', `/credentials`, sendData);
+				},
+
+				// Returns all credential types
+				getCredentialTypes: (): Promise<ICredentialType[]> => {
+					return self.restApi().makeRestApiRequest('GET', `/credential-types`);
+				},
+
+				// Returns the execution with the given name
+				getExecution: async (id: string): Promise<IExecutionResponse> => {
+					const response = await self.restApi().makeRestApiRequest('GET', `/executions/${id}`);
+					return unflattenExecutionData(response);
+				},
+
+				// Deletes executions
+				deleteExecutions: (sendData: IExecutionDeleteFilter): Promise<void> => {
+					return self.restApi().makeRestApiRequest('POST', `/executions/delete`, sendData);
+				},
+
+				// Returns the execution with the given name
+				retryExecution: (id: string): Promise<IExecutionResponse> => {
+					return self.restApi().makeRestApiRequest('POST', `/executions/${id}/retry`);
+				},
+
+				// Returns all saved executions
+				// TODO: For sure needs some kind of default filter like last day, with max 10 results, ...
+				getPastExecutions: (filter: object, limit: number, lastStartedAt?: number): Promise<IExecutionsListResponse> => {
+					let sendData = {};
+					if (filter) {
+						sendData = {
+							filter,
+							lastStartedAt,
+							limit,
+						};
+					}
+
+					return self.restApi().makeRestApiRequest('GET', `/executions`, sendData);
+				},
+
+				// Returns all the available timezones
+				getTimezones: (): Promise<IDataObject> => {
+					return self.restApi().makeRestApiRequest('GET', `/options/timezones`);
+				},
+			};
+		},
+	},
+});