feat: add and remove tags

Author: marian2js

apps/api/src/contacts/services/contact.service.ts

@@ -1,4 +1,5 @@
 import { BaseService } from '@app/common/base/base.service'
+import { Reference } from '@app/common/typings/mongodb'
 import {
   getWalletEns,
   getWalletFarcasterProfile,
@@ -7,16 +8,20 @@ import {
 } from '@app/definitions/utils/address.utils'
 import { Injectable, Logger } from '@nestjs/common'
 import { ReturnModelType } from '@typegoose/typegoose'
+import { uniq } from 'lodash'
+import { ObjectId } from 'mongodb'
 import { InjectModel } from 'nestjs-typegoose'
 import { User } from '../../users/entities/user'
 import { Contact } from '../entities/contact'
 
 @Injectable()
 export class ContactService extends BaseService<Contact> {
   protected readonly logger = new Logger(ContactService.name)
+  static instance: ContactService
 
   constructor(@InjectModel(Contact) protected readonly model: ReturnModelType<typeof Contact>) {
     super(model)
+    ContactService.instance = this
   }
 
   async resolveContactData(address: string, key: string, contactOwner: User) {
@@ -34,4 +39,49 @@ export class ContactService extends BaseService<Contact> {
         return contact?.tags ?? []
     }
   }
+
+  async addTags(address: string, tags: string[], ownerId: ObjectId): Promise<string[]> {
+    const contact = await this.findOne({
+      owner: ownerId,
+      address,
+    })
+    if (!contact) {
+      await this.createOne({
+        owner: ownerId as Reference<User>,
+        address,
+        tags,
+      })
+      return tags
+    }
+    if (tags.length) {
+      const newTags = uniq([...contact.tags, ...tags])
+      if (newTags.length !== contact.tags.length) {
+        await this.updateById(contact._id, {
+          tags: newTags,
+        })
+        return newTags
+      }
+    }
+    return contact.tags
+  }
+
+  async removeTags(address: string, tags: string[], ownerId: ObjectId): Promise<string[]> {
+    const contact = await this.findOne({
+      owner: ownerId,
+      address,
+    })
+    if (!contact) {
+      return []
+    }
+    if (tags.length) {
+      const newTags = contact.tags.filter((tag) => !tags.includes(tag))
+      if (newTags.length !== contact.tags.length) {
+        await this.updateById(contact._id, {
+          tags: newTags,
+        })
+        return newTags
+      }
+    }
+    return contact.tags
+  }
 }

apps/api/src/workflow-triggers/controllers/chatbot.controller.ts

@@ -1,7 +1,6 @@
 import { XmtpMessageOutput } from '@app/definitions/integration-definitions/xmtp/xmtp.common'
 import { BadRequestException, Body, Controller, Logger, Post, Req, UnauthorizedException } from '@nestjs/common'
 import { Request } from 'express'
-import { uniq } from 'lodash'
 import { ObjectId } from 'mongodb'
 import { Types } from 'mongoose'
 import { RunnerService } from '../../../../runner/src/services/runner.service'
@@ -162,25 +161,9 @@ export class ChatbotController {
 
     // TODO apply activateForNewConversations
 
-    const tags = workflowTrigger.inputs?.tags?.split(',').map((tag) => tag.trim()) ?? []
-    const contact = await this.contactService.findOne({
-      owner: workflow.owner,
-      address: message.senderAddress,
-    })
-    if (!contact) {
-      await this.contactService.createOne({
-        owner: workflow.owner,
-        address: message.senderAddress,
-        tags,
-      })
-    } else if (workflowTrigger.inputs?.tags) {
-      const newTags = uniq([...contact.tags, ...tags])
-      if (newTags.length !== contact.tags.length) {
-        await this.contactService.updateById(contact._id, {
-          tags: contact.tags,
-        })
-      }
-    }
+    // add tags to the contact
+    const tags: string[] = workflowTrigger.inputs?.tags?.split(',').map((tag: string) => tag.trim()) ?? []
+    await this.contactService.addTags(message.senderAddress, tags, workflow.owner._id)
 
     const hookTriggerOutputs = {
       id: message.id,

generated/graphql.ts

@@ -1107,6 +1107,13 @@ export interface IntegrationTriggersConnection {
     edges: IntegrationTriggerEdge[];
 }
 
+export interface Contact {
+    id: string;
+    createdAt: DateTime;
+    address: string;
+    tags?: Nullable<string[]>;
+}
+
 export interface AccountCredential {
     id: string;
     createdAt: DateTime;
@@ -1207,13 +1214,6 @@ export interface UserEdge {
     cursor: ConnectionCursor;
 }
 
-export interface Contact {
-    id: string;
-    createdAt: DateTime;
-    address: string;
-    tags?: Nullable<string[]>;
-}
-
 export interface ContactDeleteResponse {
     id?: Nullable<string>;
     createdAt?: Nullable<DateTime>;

generated/schema.graphql

@@ -416,6 +416,13 @@ type IntegrationTriggersConnection {
   edges: [IntegrationTriggerEdge!]!
 }
 
+type Contact {
+  id: ID!
+  createdAt: DateTime!
+  address: String!
+  tags: [String!]
+}
+
 type AccountCredential {
   id: ID!
   createdAt: DateTime!
@@ -550,13 +557,6 @@ type UserEdge {
   cursor: ConnectionCursor!
 }
 
-type Contact {
-  id: ID!
-  createdAt: DateTime!
-  address: String!
-  tags: [String!]
-}
-
 type ContactDeleteResponse {
   id: ID
   createdAt: DateTime

libs/definitions/src/integration-definition.factory.ts

@@ -21,6 +21,7 @@ import { ChatbotDefinition } from './integration-definitions/chatbot/chatbot.def
 import { ClvscanDefinition } from './integration-definitions/clvscan.definition'
 import { CoinbaseDefinition } from './integration-definitions/coinbase.definition'
 import { CoinMarketCapDefinition } from './integration-definitions/coinmarketcap.definition'
+import { ContactsDefinition } from './integration-definitions/contacts/contacts.definition'
 import { CronoscanDefinition } from './integration-definitions/cronoscan.definition'
 import { DecentralandMarketplaceDefinition } from './integration-definitions/decentraland-marketplace.definition'
 import { DexScreenerDefinition } from './integration-definitions/dexscreener.definition'
@@ -96,6 +97,7 @@ export class IntegrationDefinitionFactory {
     clvscan: ClvscanDefinition,
     coinbase: CoinbaseDefinition,
     coinmarketcap: CoinMarketCapDefinition,
+    contacts: ContactsDefinition,
     cronoscan: CronoscanDefinition,
     // compoundv2: CompoundV2Definition,
     'decentraland-marketplace': DecentralandMarketplaceDefinition,

libs/definitions/src/integration-definitions/contacts/actions/add-tag-contact.action.ts

@@ -0,0 +1,56 @@
+import { AuthenticationError } from '@app/common/errors/authentication-error'
+import { RunResponse } from '@app/definitions/definition'
+import { OperationOffChain } from '@app/definitions/opertion-offchain'
+import { ContactService } from 'apps/api/src/contacts/services/contact.service'
+import { OperationRunOptions } from 'apps/runner/src/services/operation-runner.service'
+import { isAddress } from 'ethers/lib/utils'
+import { JSONSchema7, JSONSchema7Definition } from 'json-schema'
+import { ObjectId } from 'mongodb'
+
+export class AddTagContactAction extends OperationOffChain {
+  key = 'addTagContact'
+  name = 'Add a tag to a contact'
+  description = 'Add one or more tags to a contact'
+  version = '1.0.0'
+
+  inputs: JSONSchema7 = {
+    required: ['address', 'tags'],
+    properties: {
+      // TODO this should be auto-filled on chatbots but not automations
+      address: {
+        title: 'Wallet Address',
+        type: 'string',
+        'x-ui:widget': 'hidden',
+        default: '{{contact.address}}',
+      } as JSONSchema7Definition,
+      tags: {
+        title: 'Tags',
+        type: 'string',
+        description: 'Tags to add to the contact. Separate multiple tags with a comma.',
+      },
+    },
+  }
+  outputs: JSONSchema7 = {
+    properties: {
+      tags: {
+        type: 'array',
+        items: {
+          type: 'string',
+        },
+      },
+    },
+  }
+
+  async run({ inputs, user }: OperationRunOptions): Promise<RunResponse> {
+    if (!isAddress(inputs.address)) {
+      throw new AuthenticationError('Invalid address')
+    }
+    const tags: string[] = inputs?.tags?.split(',').map((tag: string) => tag.trim()) ?? []
+    const updatedTags = await ContactService.instance.addTags(inputs.address, tags, new ObjectId(user!.id))
+    return {
+      outputs: {
+        tags: updatedTags,
+      },
+    }
+  }
+}

libs/definitions/src/integration-definitions/contacts/actions/remove-tag-contact.action.ts

@@ -0,0 +1,56 @@
+import { AuthenticationError } from '@app/common/errors/authentication-error'
+import { RunResponse } from '@app/definitions/definition'
+import { OperationOffChain } from '@app/definitions/opertion-offchain'
+import { ContactService } from 'apps/api/src/contacts/services/contact.service'
+import { OperationRunOptions } from 'apps/runner/src/services/operation-runner.service'
+import { isAddress } from 'ethers/lib/utils'
+import { JSONSchema7, JSONSchema7Definition } from 'json-schema'
+import { ObjectId } from 'mongodb'
+
+export class RemoveTagContactAction extends OperationOffChain {
+  key = 'removeTagContact'
+  name = 'Remove a tag from a contact'
+  description = 'Remove one or more tags from a contact'
+  version = '1.0.0'
+
+  inputs: JSONSchema7 = {
+    required: ['address', 'tags'],
+    properties: {
+      // TODO this should be auto-filled on chatbots but not automations
+      address: {
+        title: 'Wallet Address',
+        type: 'string',
+        'x-ui:widget': 'hidden',
+        default: '{{contact.address}}',
+      } as JSONSchema7Definition,
+      tags: {
+        title: 'Tags',
+        type: 'string',
+        description: 'Tags to add to the contact. Separate multiple tags with a comma.',
+      },
+    },
+  }
+  outputs: JSONSchema7 = {
+    properties: {
+      tags: {
+        type: 'array',
+        items: {
+          type: 'string',
+        },
+      },
+    },
+  }
+
+  async run({ inputs, user }: OperationRunOptions): Promise<RunResponse> {
+    if (!isAddress(inputs.address)) {
+      throw new AuthenticationError('Invalid address')
+    }
+    const tags: string[] = inputs?.tags?.split(',').map((tag: string) => tag.trim()) ?? []
+    const updatedTags = await ContactService.instance.removeTags(inputs.address, tags, new ObjectId(user!.id))
+    return {
+      outputs: {
+        tags: updatedTags,
+      },
+    }
+  }
+}

libs/definitions/src/integration-definitions/contacts/contacts.definition.ts

@@ -0,0 +1,12 @@
+import { SingleIntegrationDefinition } from '@app/definitions/single-integration.definition'
+import { AddTagContactAction } from './actions/add-tag-contact.action'
+import { RemoveTagContactAction } from './actions/remove-tag-contact.action'
+
+export class ContactsDefinition extends SingleIntegrationDefinition {
+  integrationKey = 'contacts'
+  integrationVersion = '1'
+  schemaUrl = null
+
+  triggers = []
+  actions = [new AddTagContactAction(), new RemoveTagContactAction()]
+}

schemas/openapi3/contacts-1.json

@@ -0,0 +1,10 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Contacts",
+    "version": "1",
+    "x-categories": [],
+    "x-logo": { "url": "/img/contact.svg" }
+  },
+  "paths": {}
+}