Last email interaction extension (#15511)

Challenge 4 from "Call for projects" list

packages/twenty-apps/last_email_interaction/.yarnrc.yml

@@ -0,0 +1,3 @@
+yarnPath: .yarn/releases/yarn-4.9.2.cjs
+
+nodeLinker: node-modules

packages/twenty-apps/last_email_interaction/README.md

@@ -0,0 +1,21 @@
+# Last email interaction
+
+Updates Last interaction and Interaction status fields based on last email date
+
+## Requirements
+- twenty-cli `npm install -g twenty-cli`
+- an `apiKey`. Go to `https://twenty.com/settings/api-webhooks` to generate one
+
+## Setup
+1. Add and synchronize app
+```bash
+twenty auth login
+cd last_email_interaction
+twenty app sync
+```
+2. Go to Settings > Integrations > Last email interaction > Settings and add required variables
+
+## Flow
+- Checks if fields are created, if not, creates them on fly
+- Extracts the timedate of message and calculates the last interaction status
+- Fetches all users and companies connected to them and updates their Last interaction and Interaction status fields

packages/twenty-apps/last_email_interaction/package.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.0.1",
+  "license": "MIT",
+  "engines": {
+    "node": "^24.5.0",
+    "npm": "please-use-yarn",
+    "yarn": ">=4.0.2"
+  },
+  "packageManager": "yarn@4.9.2",
+  "$schema": "https://raw.githubusercontent.com/twentyhq/twenty/main/packages/twenty-cli/schemas/appManifest.schema.json",
+  "universalIdentifier": "718ed9ab-53fc-49c8-8deb-0cff78ecf0d2",
+  "name": "Last email interaction",
+  "description": "Updates Last interaction and Interaction status fields based on last received email",
+  "env": {
+    "TWENTY_API_KEY": {
+      "isSecret": true,
+      "value": "",
+      "description": "Required to send requests to Twenty"
+    },
+    "TWENTY_API_URL": {
+      "isSecret": false,
+      "value": "",
+      "description": "Optional, defaults to cloud API URL"
+    }
+  },
+  "dependencies": {
+    "axios": "^1.12.2"
+  }
+}

packages/twenty-apps/last_email_interaction/serverlessFunctions/test/serverlessFunction.manifest.jsonc

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://raw.githubusercontent.com/twentyhq/twenty/main/packages/twenty-cli/schemas/serverlessFunction.schema.json",
+  "universalIdentifier": "683966a0-b60a-424e-86b1-7448c9191bde",
+  "name": "test",
+  "triggers": [
+    {
+      "universalIdentifier": "f4f1e127-87f0-4dcf-99fe-8061adf5cbe6",
+      "type": "databaseEvent",
+      "eventName": "message.created"
+    },
+    {
+      "universalIdentifier": "4c17878f-b6b3-4d0a-8de6-967b1cb55002",
+      "type": "databaseEvent",
+      "eventName": "message.updated"
+    }
+  ]
+}

packages/twenty-apps/last_email_interaction/serverlessFunctions/test/src/index.ts

@@ -0,0 +1,275 @@
+import axios from 'axios';
+import { setTimeout } from 'timers/promises';
+
+const TWENTY_API_KEY = process.env.TWENTY_API_KEY ?? '';
+const TWENTY_URL =
+  process.env.TWENTY_API_URL !== '' && process.env.TWENTY_API_URL !== undefined
+    ? `${process.env.TWENTY_API_URL}/rest`
+    : 'https://api.twenty.com/rest';
+const DELAY = 500;
+
+const create_last_interaction = (id: string) => {
+  return {
+    method: 'POST',
+    url: `${TWENTY_URL}/metadata/fields`,
+    headers: {
+      'Content-Type': 'application/json',
+      Authorization: `Bearer ${TWENTY_API_KEY}`,
+    },
+    data: {
+      type: 'DATE_TIME',
+      objectMetadataId: `${id}`,
+      name: 'lastInteraction',
+      label: 'Last interaction',
+      description: 'Date when the last interaction happened',
+      icon: 'IconCalendarClock',
+      defaultValue: null,
+      isNullable: true,
+      settings: {},
+    },
+  };
+};
+
+const create_interaction_status = (id: string) => {
+  return {
+    method: 'POST',
+    url: `${TWENTY_URL}/metadata/fields`,
+    headers: {
+      'Content-Type': 'application/json',
+      Authorization: `Bearer ${TWENTY_API_KEY}`,
+    },
+    data: {
+      type: 'SELECT',
+      objectMetadataId: `${id}`,
+      name: 'interactionStatus',
+      label: 'Interaction status',
+      description: 'Indicates the health of relation',
+      icon: 'IconProgress',
+      defaultValue: null,
+      isNullable: true,
+      settings: {},
+      options: [
+        {
+          color: 'green',
+          label: 'Recent',
+          value: 'RECENT',
+          position: 1,
+        },
+        {
+          color: 'yellow',
+          label: 'Active',
+          value: 'ACTIVE',
+          position: 2,
+        },
+        {
+          color: 'sky',
+          label: 'Cooling',
+          value: 'COOLING',
+          position: 3,
+        },
+        {
+          color: 'gray',
+          label: 'Dormant',
+          value: 'DORMANT',
+          position: 4,
+        },
+      ],
+    },
+  };
+};
+
+const calculateStatus = (date: string) => {
+  const day = 1000 * 60 * 60 * 24;
+  const now = Date.now();
+  const messageDate = Date.parse(date);
+  const deltaTime = now - messageDate;
+  return deltaTime < 7 * day
+    ? 'RECENT'
+    : deltaTime < 30 * day
+      ? 'ACTIVE'
+      : deltaTime < 90 * day
+        ? 'COOLING'
+        : 'DORMANT';
+};
+
+const interactionData = (date: string, status: string) => {
+  return {
+    lastInteraction: date,
+    interactionStatus: status,
+  };
+};
+
+export const main = async (params: {
+  properties: Record<string, any>;
+  recordId: string;
+  userId: string;
+}): Promise<object> => {
+  if (TWENTY_API_KEY === '') {
+    console.log("Function exited as API key or URL hasn't been set properly");
+    return {};
+  }
+  const { properties, recordId } = params;
+  // Check if fields are created
+  const options = {
+    method: 'GET',
+    url: `${TWENTY_URL}/metadata/objects`,
+    headers: {
+      Authorization: `Bearer ${TWENTY_API_KEY}`,
+    },
+  };
+  try {
+    const response = await axios.request(options);
+    const objects = response.data.data.objects;
+    const company_object = objects.find(
+      (object) => object.nameSingular === 'company',
+    );
+    const company_last_interaction = company_object.fields.find(
+      (field) => field.name === 'lastInteraction',
+    );
+    const company_interaction_status = company_object.fields.find(
+      (field) => field.name === 'interactionStatus',
+    );
+    const person_object = objects.find(
+      (object) => object.nameSingular === 'person',
+    );
+    const person_last_interaction = person_object.fields.find(
+      (field) => field.name === 'lastInteraction',
+    );
+    const person_interaction_status = person_object.fields.find(
+      (field) => field.name === 'interactionStatus',
+    );
+    // If not, create them
+    if (company_last_interaction === undefined) {
+      const response2 = await axios.request(
+        create_last_interaction(company_object.id),
+      );
+      if (response2.status === 201) {
+        console.log('Successfully created company last interaction field');
+      }
+      await setTimeout(DELAY);
+    }
+    if (company_interaction_status === undefined) {
+      const response2 = await axios.request(
+        create_interaction_status(company_object.id),
+      );
+      if (response2.status === 201) {
+        console.log('Successfully created company interaction status field');
+      }
+      await setTimeout(DELAY);
+    }
+    if (person_last_interaction === undefined) {
+      const response2 = await axios.request(
+        create_last_interaction(person_object.id),
+      );
+      if (response2.status === 201) {
+        console.log('Successfully created person last interaction field');
+      }
+      await setTimeout(DELAY);
+    }
+    if (person_interaction_status === undefined) {
+      const response2 = await axios.request(
+        create_interaction_status(person_object.id),
+      );
+      if (response2.status === 201) {
+        console.log('Successfully created person interaction status field');
+      }
+      await setTimeout(DELAY);
+    }
+
+    // Extract the timestamp of message
+    const messageDate = properties.receivedAt;
+    const interactionStatus = calculateStatus(messageDate);
+
+    // Get the details of person and related company
+    const messageOptions = {
+      method: 'GET',
+      url: `${TWENTY_URL}/messages/${recordId}?depth=1`,
+      headers: {
+        Authorization: `Bearer ${TWENTY_API_KEY}`,
+      },
+    };
+    const messageDetails = await axios.request(messageOptions);
+    await setTimeout(DELAY);
+    const peopleIds = [];
+    for (const participant of messageDetails.data.messages
+      .messageParticipants) {
+      peopleIds.push(participant.personId);
+    }
+
+    const companiesIds = [];
+    for (const id of peopleIds) {
+      const options = {
+        method: 'GET',
+        url: `${TWENTY_URL}/people/${id}`,
+        headers: {
+          Authorization: `Bearer ${TWENTY_API_KEY}`,
+        },
+      };
+      try {
+        const req = await axios.request(options);
+        companiesIds.push(req.data.person.companyId);
+        await setTimeout(DELAY);
+      } catch (error) {
+        if (axios.isAxiosError(error)) {
+          throw error;
+        }
+        throw error;
+      }
+    }
+    // Update the field value depending on the timestamp
+    for (const id of peopleIds) {
+      const peopleOptions = {
+        method: 'PATCH',
+        url: `${TWENTY_URL}/people/${id}`,
+        headers: {
+          'Content-Type': 'application/json',
+          Authorization: `Bearer ${TWENTY_API_KEY}`,
+        },
+        data: interactionData(messageDate, interactionStatus),
+      };
+      try {
+        const response = await axios.request(options);
+        if (response.status === 200) {
+          console.log('Successfully updated company last interaction field');
+          await setTimeout(DELAY);
+        }
+      } catch (error) {
+        if (axios.isAxiosError(error)) {
+          throw error;
+        }
+        throw error;
+      }
+    }
+
+    for (const id of companiesIds) {
+      const companiesOptions = {
+        method: 'PATCH',
+        url: `${TWENTY_URL}/companies/${id}`,
+        headers: {
+          'Content-Type': 'application/json',
+          Authorization: `Bearer ${TWENTY_API_KEY}`,
+        },
+        data: interactionData(messageDate, interactionStatus),
+      };
+      try {
+        const req = await axios.request(companiesOptions);
+        if (req.status === 200) {
+          console.log(`Successfully updated company with ID ${id}`);
+          await setTimeout(DELAY);
+        }
+      } catch (error) {
+        if (axios.isAxiosError(error)) {
+          throw error;
+        }
+        throw error;
+      }
+    }
+  } catch (error) {
+    if (axios.isAxiosError(error)) {
+      console.error(error);
+      return {};
+    }
+    console.log(error);
+    return {};
+  }
+};

packages/twenty-apps/last_email_interaction/yarn.lock

@@ -0,0 +1,248 @@
+# This file is generated by running "yarn install" inside your project.
+# Manual changes might be lost - proceed with caution!
+
+__metadata:
+  version: 8
+  cacheKey: 10c0
+
+"Last email interaction@workspace:.":
+  version: 0.0.0-use.local
+  resolution: "Last email interaction@workspace:."
+  dependencies:
+    axios: "npm:^1.12.2"
+  languageName: unknown
+  linkType: soft
+
+"async-function@npm:^1.0.0":
+  version: 1.0.0
+  resolution: "async-function@npm:1.0.0"
+  checksum: 10c0/669a32c2cb7e45091330c680e92eaeb791bc1d4132d827591e499cd1f776ff5a873e77e5f92d0ce795a8d60f10761dec9ddfe7225a5de680f5d357f67b1aac73
+  languageName: node
+  linkType: hard
+
+"async-generator-function@npm:^1.0.0":
+  version: 1.0.0
+  resolution: "async-generator-function@npm:1.0.0"
+  checksum: 10c0/2c50ef856c543ad500d8d8777d347e3c1ba623b93e99c9263ecc5f965c1b12d2a140e2ab6e43c3d0b85366110696f28114649411cbcd10b452a92a2318394186
+  languageName: node
+  linkType: hard
+
+"asynckit@npm:^0.4.0":
+  version: 0.4.0
+  resolution: "asynckit@npm:0.4.0"
+  checksum: 10c0/d73e2ddf20c4eb9337e1b3df1a0f6159481050a5de457c55b14ea2e5cb6d90bb69e004c9af54737a5ee0917fcf2c9e25de67777bbe58261847846066ba75bc9d
+  languageName: node
+  linkType: hard
+
+"axios@npm:^1.12.2":
+  version: 1.12.2
+  resolution: "axios@npm:1.12.2"
+  dependencies:
+    follow-redirects: "npm:^1.15.6"
+    form-data: "npm:^4.0.4"
+    proxy-from-env: "npm:^1.1.0"
+  checksum: 10c0/80b063e318cf05cd33a4d991cea0162f3573481946f9129efb7766f38fde4c061c34f41a93a9f9521f02b7c9565ccbc197c099b0186543ac84a24580017adfed
+  languageName: node
+  linkType: hard
+
+"call-bind-apply-helpers@npm:^1.0.1, call-bind-apply-helpers@npm:^1.0.2":
+  version: 1.0.2
+  resolution: "call-bind-apply-helpers@npm:1.0.2"
+  dependencies:
+    es-errors: "npm:^1.3.0"
+    function-bind: "npm:^1.1.2"
+  checksum: 10c0/47bd9901d57b857590431243fea704ff18078b16890a6b3e021e12d279bbf211d039155e27d7566b374d49ee1f8189344bac9833dec7a20cdec370506361c938
+  languageName: node
+  linkType: hard
+
+"combined-stream@npm:^1.0.8":
+  version: 1.0.8
+  resolution: "combined-stream@npm:1.0.8"
+  dependencies:
+    delayed-stream: "npm:~1.0.0"
+  checksum: 10c0/0dbb829577e1b1e839fa82b40c07ffaf7de8a09b935cadd355a73652ae70a88b4320db322f6634a4ad93424292fa80973ac6480986247f1734a1137debf271d5
+  languageName: node
+  linkType: hard
+
+"delayed-stream@npm:~1.0.0":
+  version: 1.0.0
+  resolution: "delayed-stream@npm:1.0.0"
+  checksum: 10c0/d758899da03392e6712f042bec80aa293bbe9e9ff1b2634baae6a360113e708b91326594c8a486d475c69d6259afb7efacdc3537bfcda1c6c648e390ce601b19
+  languageName: node
+  linkType: hard
+
+"dunder-proto@npm:^1.0.1":
+  version: 1.0.1
+  resolution: "dunder-proto@npm:1.0.1"
+  dependencies:
+    call-bind-apply-helpers: "npm:^1.0.1"
+    es-errors: "npm:^1.3.0"
+    gopd: "npm:^1.2.0"
+  checksum: 10c0/199f2a0c1c16593ca0a145dbf76a962f8033ce3129f01284d48c45ed4e14fea9bbacd7b3610b6cdc33486cef20385ac054948fefc6272fcce645c09468f93031
+  languageName: node
+  linkType: hard
+
+"es-define-property@npm:^1.0.1":
+  version: 1.0.1
+  resolution: "es-define-property@npm:1.0.1"
+  checksum: 10c0/3f54eb49c16c18707949ff25a1456728c883e81259f045003499efba399c08bad00deebf65cccde8c0e07908c1a225c9d472b7107e558f2a48e28d530e34527c
+  languageName: node
+  linkType: hard
+
+"es-errors@npm:^1.3.0":
+  version: 1.3.0
+  resolution: "es-errors@npm:1.3.0"
+  checksum: 10c0/0a61325670072f98d8ae3b914edab3559b6caa980f08054a3b872052640d91da01d38df55df797fcc916389d77fc92b8d5906cf028f4db46d7e3003abecbca85
+  languageName: node
+  linkType: hard
+
+"es-object-atoms@npm:^1.0.0, es-object-atoms@npm:^1.1.1":
+  version: 1.1.1
+  resolution: "es-object-atoms@npm:1.1.1"
+  dependencies:
+    es-errors: "npm:^1.3.0"
+  checksum: 10c0/65364812ca4daf48eb76e2a3b7a89b3f6a2e62a1c420766ce9f692665a29d94fe41fe88b65f24106f449859549711e4b40d9fb8002d862dfd7eb1c512d10be0c
+  languageName: node
+  linkType: hard
+
+"es-set-tostringtag@npm:^2.1.0":
+  version: 2.1.0
+  resolution: "es-set-tostringtag@npm:2.1.0"
+  dependencies:
+    es-errors: "npm:^1.3.0"
+    get-intrinsic: "npm:^1.2.6"
+    has-tostringtag: "npm:^1.0.2"
+    hasown: "npm:^2.0.2"
+  checksum: 10c0/ef2ca9ce49afe3931cb32e35da4dcb6d86ab02592cfc2ce3e49ced199d9d0bb5085fc7e73e06312213765f5efa47cc1df553a6a5154584b21448e9fb8355b1af
+  languageName: node
+  linkType: hard
+
+"follow-redirects@npm:^1.15.6":
+  version: 1.15.11
+  resolution: "follow-redirects@npm:1.15.11"
+  peerDependenciesMeta:
+    debug:
+      optional: true
+  checksum: 10c0/d301f430542520a54058d4aeeb453233c564aaccac835d29d15e050beb33f339ad67d9bddbce01739c5dc46a6716dbe3d9d0d5134b1ca203effa11a7ef092343
+  languageName: node
+  linkType: hard
+
+"form-data@npm:^4.0.4":
+  version: 4.0.4
+  resolution: "form-data@npm:4.0.4"
+  dependencies:
+    asynckit: "npm:^0.4.0"
+    combined-stream: "npm:^1.0.8"
+    es-set-tostringtag: "npm:^2.1.0"
+    hasown: "npm:^2.0.2"
+    mime-types: "npm:^2.1.12"
+  checksum: 10c0/373525a9a034b9d57073e55eab79e501a714ffac02e7a9b01be1c820780652b16e4101819785e1e18f8d98f0aee866cc654d660a435c378e16a72f2e7cac9695
+  languageName: node
+  linkType: hard
+
+"function-bind@npm:^1.1.2":
+  version: 1.1.2
+  resolution: "function-bind@npm:1.1.2"
+  checksum: 10c0/d8680ee1e5fcd4c197e4ac33b2b4dce03c71f4d91717292785703db200f5c21f977c568d28061226f9b5900cbcd2c84463646134fd5337e7925e0942bc3f46d5
+  languageName: node
+  linkType: hard
+
+"generator-function@npm:^2.0.0":
+  version: 2.0.1
+  resolution: "generator-function@npm:2.0.1"
+  checksum: 10c0/8a9f59df0f01cfefafdb3b451b80555e5cf6d76487095db91ac461a0e682e4ff7a9dbce15f4ecec191e53586d59eece01949e05a4b4492879600bbbe8e28d6b8
+  languageName: node
+  linkType: hard
+
+"get-intrinsic@npm:^1.2.6":
+  version: 1.3.1
+  resolution: "get-intrinsic@npm:1.3.1"
+  dependencies:
+    async-function: "npm:^1.0.0"
+    async-generator-function: "npm:^1.0.0"
+    call-bind-apply-helpers: "npm:^1.0.2"
+    es-define-property: "npm:^1.0.1"
+    es-errors: "npm:^1.3.0"
+    es-object-atoms: "npm:^1.1.1"
+    function-bind: "npm:^1.1.2"
+    generator-function: "npm:^2.0.0"
+    get-proto: "npm:^1.0.1"
+    gopd: "npm:^1.2.0"
+    has-symbols: "npm:^1.1.0"
+    hasown: "npm:^2.0.2"
+    math-intrinsics: "npm:^1.1.0"
+  checksum: 10c0/9f4ab0cf7efe0fd2c8185f52e6f637e708f3a112610c88869f8f041bb9ecc2ce44bf285dfdbdc6f4f7c277a5b88d8e94a432374d97cca22f3de7fc63795deb5d
+  languageName: node
+  linkType: hard
+
+"get-proto@npm:^1.0.1":
+  version: 1.0.1
+  resolution: "get-proto@npm:1.0.1"
+  dependencies:
+    dunder-proto: "npm:^1.0.1"
+    es-object-atoms: "npm:^1.0.0"
+  checksum: 10c0/9224acb44603c5526955e83510b9da41baf6ae73f7398875fba50edc5e944223a89c4a72b070fcd78beb5f7bdda58ecb6294adc28f7acfc0da05f76a2399643c
+  languageName: node
+  linkType: hard
+
+"gopd@npm:^1.2.0":
+  version: 1.2.0
+  resolution: "gopd@npm:1.2.0"
+  checksum: 10c0/50fff1e04ba2b7737c097358534eacadad1e68d24cccee3272e04e007bed008e68d2614f3987788428fd192a5ae3889d08fb2331417e4fc4a9ab366b2043cead
+  languageName: node
+  linkType: hard
+
+"has-symbols@npm:^1.0.3, has-symbols@npm:^1.1.0":
+  version: 1.1.0
+  resolution: "has-symbols@npm:1.1.0"
+  checksum: 10c0/dde0a734b17ae51e84b10986e651c664379018d10b91b6b0e9b293eddb32f0f069688c841fb40f19e9611546130153e0a2a48fd7f512891fb000ddfa36f5a20e
+  languageName: node
+  linkType: hard
+
+"has-tostringtag@npm:^1.0.2":
+  version: 1.0.2
+  resolution: "has-tostringtag@npm:1.0.2"
+  dependencies:
+    has-symbols: "npm:^1.0.3"
+  checksum: 10c0/a8b166462192bafe3d9b6e420a1d581d93dd867adb61be223a17a8d6dad147aa77a8be32c961bb2f27b3ef893cae8d36f564ab651f5e9b7938ae86f74027c48c
+  languageName: node
+  linkType: hard
+
+"hasown@npm:^2.0.2":
+  version: 2.0.2
+  resolution: "hasown@npm:2.0.2"
+  dependencies:
+    function-bind: "npm:^1.1.2"
+  checksum: 10c0/3769d434703b8ac66b209a4cca0737519925bbdb61dd887f93a16372b14694c63ff4e797686d87c90f08168e81082248b9b028bad60d4da9e0d1148766f56eb9
+  languageName: node
+  linkType: hard
+
+"math-intrinsics@npm:^1.1.0":
+  version: 1.1.0
+  resolution: "math-intrinsics@npm:1.1.0"
+  checksum: 10c0/7579ff94e899e2f76ab64491d76cf606274c874d8f2af4a442c016bd85688927fcfca157ba6bf74b08e9439dc010b248ce05b96cc7c126a354c3bae7fcb48b7f
+  languageName: node
+  linkType: hard
+
+"mime-db@npm:1.52.0":
+  version: 1.52.0
+  resolution: "mime-db@npm:1.52.0"
+  checksum: 10c0/0557a01deebf45ac5f5777fe7740b2a5c309c6d62d40ceab4e23da9f821899ce7a900b7ac8157d4548ddbb7beffe9abc621250e6d182b0397ec7f10c7b91a5aa
+  languageName: node
+  linkType: hard
+
+"mime-types@npm:^2.1.12":
+  version: 2.1.35
+  resolution: "mime-types@npm:2.1.35"
+  dependencies:
+    mime-db: "npm:1.52.0"
+  checksum: 10c0/82fb07ec56d8ff1fc999a84f2f217aa46cb6ed1033fefaabd5785b9a974ed225c90dc72fff460259e66b95b73648596dbcc50d51ed69cdf464af2d237d3149b2
+  languageName: node
+  linkType: hard
+
+"proxy-from-env@npm:^1.1.0":
+  version: 1.1.0
+  resolution: "proxy-from-env@npm:1.1.0"
+  checksum: 10c0/fe7dd8b1bdbbbea18d1459107729c3e4a2243ca870d26d34c2c1bcd3e4425b7bcc5112362df2d93cc7fb9746f6142b5e272fd1cc5c86ddf8580175186f6ad42b
+  languageName: node
+  linkType: hard