n8n-nodes-qlik-cloud 1.0.0

package/src/nodes/QlikCloud/QlikCloud.node.ts

@@ -0,0 +1,424 @@
+import type {
+	IExecuteFunctions,
+	INodeExecutionData,
+	INodeType,
+	INodeTypeDescription,
+	GenericValue,
+	IGetNodeParameterOptions,
+} from 'n8n-workflow';
+import { NodeOperationError } from 'n8n-workflow';
+
+import { qlikApiRequest } from '../shared/transport';
+import { appDescription } from './resources/apps/index';
+import { assistantDescription } from './resources/assistants/index';
+import { auditDescription } from './resources/audits/index';
+import { itemDescription } from './resources/items/index';
+
+export class QlikCloud implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Qlik Cloud',
+		name: 'qlikCloud',
+		icon: 'file:qlik.svg',
+		group: ['transform'],
+		version: 1,
+		subtitle: '={{$parameter["resource"] + ": " + $parameter["operation"]}}',
+		description: 'Interact with Qlik Cloud APIs (Apps, Items, Audits, Assistants)',
+		defaults: {
+			name: 'Qlik Cloud',
+		},
+		inputs: ['main'],
+		outputs: ['main'],
+		credentials: [
+			{
+				name: 'qlikCloudApi',
+				required: true,
+			},
+		],
+		properties: [
+			{
+				displayName: 'Resource',
+				name: 'resource',
+				type: 'options',
+				noDataExpression: true,
+				options: [
+					{
+						name: 'Apps',
+						value: 'apps',
+						description: 'Manage Qlik Cloud applications',
+					},
+					{
+						name: 'Assistants',
+						value: 'assistants',
+						description: 'Interact with AI assistants',
+					},
+					{
+						name: 'Audits',
+						value: 'audits',
+						description: 'Access audit logs and events',
+					},
+					{
+						name: 'Items',
+						value: 'items',
+						description: 'Manage items in Qlik Cloud',
+					},
+				],
+				default: 'apps',
+			},
+			...appDescription,
+			...assistantDescription,
+			...auditDescription,
+			...itemDescription,
+		],
+	};
+
+	async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
+		const items = this.getInputData();
+		let responseData;
+		const returnData: INodeExecutionData[] = [];
+
+		const resource = this.getNodeParameter('resource', 0) as string;
+		const operation = this.getNodeParameter('operation', 0) as string;
+
+		for (let i = 0; i < items.length; i++) {
+			try {
+				if (resource === 'apps') {
+					responseData = await this.handleAppsResource(operation);
+				} else if (resource === 'assistants') {
+					responseData = await this.handleAssistantsResource(operation);
+				} else if (resource === 'audits') {
+					responseData = await this.handleAuditsResource(operation);
+				} else if (resource === 'items') {
+					responseData = await this.handleItemsResource(operation);
+				}
+
+				const executionData = this.helpers.constructExecutionMetaData(
+					this.helpers.returnJsonArray(responseData as GenericValue[]),
+					{ itemData: { item: i } },
+				);
+				returnData.push(...executionData);
+			} catch (error) {
+				if (this.continueOnFail()) {
+					returnData.push({
+						json: { error: (error as Error).message },
+						pairedItem: i,
+					});
+				} else {
+					throw error;
+				}
+			}
+		}
+
+		return [returnData];
+	}
+
+	private async handleAppsResource(operation: string): Promise<any> {
+		if (operation === 'getAll') {
+			const returnAll = this.getNodeParameter('returnAll', 0) as boolean;
+			const limit = returnAll ? undefined : (this.getNodeParameter('limit', 0) as number);
+			const options = this.getNodeParameter('options', 0) as any;
+
+			const qs: any = {};
+			if (limit) {
+				qs.limit = limit;
+			}
+			if (options.name) {
+				qs.name = options.name;
+			}
+			if (options.spaceId) {
+				qs.spaceId = options.spaceId;
+			}
+
+			const response = await qlikApiRequest.call(this, 'GET', '/api/v1/apps', undefined, qs);
+			return response.data || response;
+		}
+
+		if (operation === 'get') {
+			const appId = this.getNodeParameter('appId', 0) as string;
+			return await qlikApiRequest.call(this, 'GET', `/api/v1/apps/${appId}`);
+		}
+
+		if (operation === 'create') {
+			const name = this.getNodeParameter('name', 0) as string;
+			const options = this.getNodeParameter('options', 0) as any;
+
+			const body = { attributes: { name } };
+			if (options.description) {
+				(body.attributes as any).description = options.description;
+			}
+			if (options.locale) {
+				(body.attributes as any).locale = options.locale;
+			}
+			if (options.spaceId) {
+				(body.attributes as any).spaceId = options.spaceId;
+			}
+
+			return await qlikApiRequest.call(this, 'POST', '/api/v1/apps', body);
+		}
+
+		if (operation === 'update') {
+			const appId = this.getNodeParameter('appId', 0) as string;
+			const body = this.getNodeParameter('body', 0) as any;
+			return await qlikApiRequest.call(this, 'PUT', `/api/v1/apps/${appId}`, body);
+		}
+
+		if (operation === 'delete') {
+			const appId = this.getNodeParameter('appId', 0) as string;
+			await qlikApiRequest.call(this, 'DELETE', `/api/v1/apps/${appId}`);
+			return { success: true };
+		}
+
+		if (operation === 'copy') {
+			const appId = this.getNodeParameter('appId', 0) as string;
+			const name = this.getNodeParameter('name', 0) as string;
+			const options = this.getNodeParameter('options', 0) as any;
+
+			const body = { attributes: { name } };
+			if (options.description) {
+				(body.attributes as any).description = options.description;
+			}
+			if (options.spaceId) {
+				(body.attributes as any).spaceId = options.spaceId;
+			}
+
+			return await qlikApiRequest.call(this, 'POST', `/api/v1/apps/${appId}/copy`, body);
+		}
+
+		if (operation === 'export') {
+			const appId = this.getNodeParameter('appId', 0) as string;
+			return await qlikApiRequest.call(this, 'POST', `/api/v1/apps/${appId}/export`, {});
+		}
+
+		if (operation === 'publish') {
+			const appId = this.getNodeParameter('appId', 0) as string;
+			const options = this.getNodeParameter('publishOptions', 0) as any;
+
+			const body: any = {};
+			if (options.spaceId) {
+				body.spaceId = options.spaceId;
+			}
+
+			return await qlikApiRequest.call(this, 'POST', `/api/v1/apps/${appId}/publish`, body);
+		}
+
+		if (operation === 'privileges') {
+			return await qlikApiRequest.call(this, 'GET', '/api/v1/apps/privileges');
+		}
+
+		throw new NodeOperationError(this.getNode(), `Unknown operation: ${operation}`);
+	}
+
+	private async handleAssistantsResource(operation: string): Promise<any> {
+		if (operation === 'getAll') {
+			const options = this.getNodeParameter('options', 0) as any;
+
+			const qs: any = {};
+			if (options.limit) {
+				qs.limit = options.limit;
+			}
+
+			return await qlikApiRequest.call(this, 'GET', '/api/v1/assistants', undefined, qs);
+		}
+
+		if (operation === 'get') {
+			const assistantId = this.getNodeParameter('assistantId', 0) as string;
+			return await qlikApiRequest.call(this, 'GET', `/api/v1/assistants/${assistantId}`);
+		}
+
+		if (operation === 'create') {
+			const name = this.getNodeParameter('name', 0) as string;
+			const options = this.getNodeParameter('options', 0) as any;
+
+			const body: any = { name };
+			if (options.description) {
+				body.description = options.description;
+			}
+
+			return await qlikApiRequest.call(this, 'POST', '/api/v1/assistants', body);
+		}
+
+		if (operation === 'search') {
+			const assistantId = this.getNodeParameter('assistantId', 0) as string;
+			const query = this.getNodeParameter('query', 0) as string;
+			const options = this.getNodeParameter('options', 0) as any;
+
+			const body: any = { text: query };
+			if (options.topN) {
+				body.topN = options.topN;
+			}
+			if (options.mode) {
+				body.mode = options.mode;
+			}
+
+			return await qlikApiRequest.call(
+				this,
+				'POST',
+				`/api/v1/assistants/${assistantId}/actions/search`,
+				body,
+			);
+		}
+
+		if (operation === 'delete') {
+			const assistantId = this.getNodeParameter('assistantId', 0) as string;
+			await qlikApiRequest.call(this, 'DELETE', `/api/v1/assistants/${assistantId}`);
+			return { success: true };
+		}
+
+		throw new NodeOperationError(this.getNode(), `Unknown operation: ${operation}`);
+	}
+
+	private async handleAuditsResource(operation: string): Promise<any> {
+		if (operation === 'getAll') {
+			const returnAll = this.getNodeParameter('returnAll', 0) as boolean;
+			const limit = returnAll ? undefined : (this.getNodeParameter('limit', 0) as number);
+			const options = this.getNodeParameter('options', 0) as any;
+
+			const qs: any = {};
+			if (limit) {
+				qs.limit = limit;
+			}
+			if (options.eventType) {
+				qs.eventType = options.eventType;
+			}
+			if (options.userId) {
+				qs.userId = options.userId;
+			}
+			if (options.source) {
+				qs.source = options.source;
+			}
+			if (options.eventTime) {
+				qs.eventTime = options.eventTime;
+			}
+			if (options.sort) {
+				qs.sort = options.sort;
+			}
+
+			const response = await qlikApiRequest.call(this, 'GET', '/api/v1/audits', undefined, qs);
+			return response.data || response;
+		}
+
+		if (operation === 'get') {
+			const auditId = this.getNodeParameter('auditId', 0) as string;
+			return await qlikApiRequest.call(this, 'GET', `/api/v1/audits/${auditId}`);
+		}
+
+		if (operation === 'getSources') {
+			const response = await qlikApiRequest.call(this, 'GET', '/api/v1/audits/sources');
+			return response.data || response;
+		}
+
+		if (operation === 'getTypes') {
+			const response = await qlikApiRequest.call(this, 'GET', '/api/v1/audits/types');
+			return response.data || response;
+		}
+
+		if (operation === 'getSettings') {
+			const response = await qlikApiRequest.call(this, 'GET', '/api/v1/audits/settings');
+			return response.data || response;
+		}
+
+		throw new NodeOperationError(this.getNode(), `Unknown operation: ${operation}`);
+	}
+
+	private async handleItemsResource(operation: string): Promise<any> {
+		if (operation === 'getAll') {
+			const returnAll = this.getNodeParameter('returnAll', 0) as boolean;
+			const limit = returnAll ? undefined : (this.getNodeParameter('limit', 0) as number);
+			const options = this.getNodeParameter('options', 0) as any;
+
+			const qs: any = {};
+			if (limit) {
+				qs.limit = limit;
+			}
+			if (options.name) {
+				qs.name = options.name;
+			}
+			if (options.resourceType) {
+				qs.resourceType = options.resourceType;
+			}
+			if (options.spaceId) {
+				qs.spaceId = options.spaceId;
+			}
+			if (options.ownerId) {
+				qs.ownerId = options.ownerId;
+			}
+			if (options.sort) {
+				qs.sort = options.sort;
+			}
+
+			const response = await qlikApiRequest.call(this, 'GET', '/api/v1/items', undefined, qs);
+			return response.data || response;
+		}
+
+		if (operation === 'get') {
+			const itemId = this.getNodeParameter('itemId', 0) as string;
+			return await qlikApiRequest.call(this, 'GET', `/api/v1/items/${itemId}`);
+		}
+
+		if (operation === 'update') {
+			const itemId = this.getNodeParameter('itemId', 0) as string;
+			const body = this.getNodeParameter('body', 0) as any;
+			return await qlikApiRequest.call(this, 'PUT', `/api/v1/items/${itemId}`, body);
+		}
+
+		if (operation === 'delete') {
+			const itemId = this.getNodeParameter('itemId', 0) as string;
+			await qlikApiRequest.call(this, 'DELETE', `/api/v1/items/${itemId}`);
+			return { success: true };
+		}
+
+		if (operation === 'collections') {
+			const itemId = this.getNodeParameter('itemId', 0) as string;
+			const options = this.getNodeParameter('options', 0) as any;
+
+			const qs: any = {};
+			if (options.limit) {
+				qs.limit = options.limit;
+			}
+
+			const response = await qlikApiRequest.call(
+				this,
+				'GET',
+				`/api/v1/items/${itemId}/collections`,
+				undefined,
+				qs,
+			);
+			return response.data || response;
+		}
+
+		if (operation === 'publishedItems') {
+			const itemId = this.getNodeParameter('itemId', 0) as string;
+			const options = this.getNodeParameter('options', 0) as any;
+
+			const qs: any = {};
+			if (options.limit) {
+				qs.limit = options.limit;
+			}
+
+			const response = await qlikApiRequest.call(
+				this,
+				'GET',
+				`/api/v1/items/${itemId}/publisheditems`,
+				undefined,
+				qs,
+			);
+			return response.data || response;
+		}
+
+		if (operation === 'settings') {
+			const settingsOperation = this.getNodeParameter('settingsOperation', 0) as string;
+
+			if (settingsOperation === 'get') {
+				const response = await qlikApiRequest.call(this, 'GET', '/api/v1/items/settings');
+				return response.data || response;
+			}
+
+			if (settingsOperation === 'patch') {
+				const body = this.getNodeParameter('body', 0) as any;
+				const response = await qlikApiRequest.call(this, 'PATCH', '/api/v1/items/settings', body);
+				return response.data || response;
+			}
+		}
+
+		throw new NodeOperationError(this.getNode(), `Unknown operation: ${operation}`);
+	}
+}