feat/workflows

package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.23.3",
+  "version": "0.24.0",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

src/index.ts

@@ -42,6 +42,7 @@ import {
 
 import { setContext } from '@apollo/client/link/context';
 import Settings from './modules/settings';
+import { Workflow } from 'modules/workflow';
 
 export * from './types';
 export * from './queries';
@@ -130,6 +131,7 @@ export default class KanvasCore {
   public contact: Contact;
   public filesystemMapper: FilesystemMapper;
   public event: Event;
+  public workflow: Workflow;
 
   constructor(protected options: Options) {
     this.client = new ApolloClient({
@@ -169,6 +171,7 @@ export default class KanvasCore {
     this.contact = new Contact(this.client);
     this.filesystemMapper = new FilesystemMapper(this.client);
     this.event = new Event(this.client);
+    this.workflow = new Workflow(this.client, this.options);
   }
   protected generateURL() {
     return new HttpLink({ uri: this.options.url });

src/modules/workflow/index.ts

@@ -0,0 +1,41 @@
+import axios from 'axios';
+
+import { RunWorkflowFromEntity, WorkflowFromEntity } from 'types/workflow';
+import { ClientType, Options } from '../../index';
+
+import { RUN_WORKFLOW_FROM_ENTITY } from 'mutations/workflow';
+
+export class Workflow {
+  protected axiosClient: any;
+  constructor(protected client: ClientType, protected options?: Options) {
+    if (this.options) {
+      this.axiosClient = axios.create({
+        baseURL: this.options.url,
+        headers: {
+          'X-Kanvas-App': this.options.key,
+          ...(this.options.adminKey && {
+            'X-Kanvas-Key': this.options.adminKey,
+          }),
+        },
+      });
+
+      this.axiosClient.interceptors.request.use(
+        this.options.authAxiosMiddleware,
+        function (error: any) {
+          return Promise.reject(error);
+        }
+      );
+    }
+  }
+
+  public async runWorkflowFromEntity(
+    input: WorkflowFromEntity
+  ): Promise<RunWorkflowFromEntity> {
+    const response = await this.client.mutate({
+      mutation: RUN_WORKFLOW_FROM_ENTITY,
+      variables: { input: input }
+    });
+
+    return response.data;
+  }
+}

src/mutations/workflow.ts

@@ -0,0 +1,7 @@
+import { gql } from '@apollo/client/core';
+
+export const RUN_WORKFLOW_FROM_ENTITY = gql`
+    mutation runWorkflowEntityInput($input: runWorkflowEntityInput!) {
+        runWorkflowFromEntity(input: $input)
+    }
+`;

src/types/workflow.ts

@@ -0,0 +1,13 @@
+
+export interface WorkflowFromEntity {
+    entity_namespace: string;
+    entity_id: string;
+    action: string;
+    params?: any;
+}
+
+export interface RunWorkflowFromEntity {
+    runWorkflowFromEntity: {
+        [key: string]: any; // Allow any structure within the response
+    };
+}

test/workflow.test.ts

@@ -0,0 +1,31 @@
+import { initializeClient, getClient } from './setupClient';
+import dotenv from 'dotenv';
+
+dotenv.config();
+
+beforeAll(async () => {
+    await initializeClient(process.env.KANVAS_APP_SECRET!);
+});
+
+/**
+ * @todo add profile photo upload test
+ */
+describe('Test the Kanvas Workflow', () => {
+
+    it('run workflow', async () => {
+        const client = getClient();
+
+        const workflow = await client.workflow.runWorkflowFromEntity({
+            entity_namespace: 'user',
+            entity_id: '2',
+            action: 'updated',
+            params: {
+                name: 'John Doe',
+            }
+        });
+
+        expect(workflow).toBeDefined();
+        expect(workflow.runWorkflowFromEntity).toBeDefined();
+        expect(workflow.runWorkflowFromEntity.success).toBeTruthy();
+    });
+});