cogfy-messenger 0.1.0 → 0.1.2

package/dist/clients/tags/tags-client.js

@@ -0,0 +1,66 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TagsClient = void 0;
+const base_client_1 = require("../base-client");
+class TagsClient extends base_client_1.BaseClient {
+    /**
+     * Calls the POST /tags endpoint
+     * @param payload The tag data to create
+     * @returns An object with the ID and the name of the newly created tag
+     */
+    create(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.axios.post('/tags', payload)).data;
+        });
+    }
+    /**
+     * Calls the DELETE /tags/:id endpoint
+     * @param id The ID of the tag to delete
+     * @returns An object with the ID and the name of the deleted tag
+     */
+    delete(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.axios.delete(`/tags/${id}`)).data;
+        });
+    }
+    /**
+     * Calls the GET /tags/:id endpoint
+     * @param id The ID of the tag to retrieve
+     * @returns The tag with the specified ID
+     */
+    get(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.axios.get(`/tags/${id}`)).data;
+        });
+    }
+    /**
+     * Calls the GET /tags endpoint
+     * @returns A list of all tags in the workspace
+     */
+    list() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.axios.get('/tags')).data;
+        });
+    }
+    /**
+     * Calls the PATCH /tags/:id endpoint
+     * @param id The ID of the tag to update
+     * @param payload The updated tag data
+     * @returns An object with the ID and the name of the updated tag
+     */
+    update(id, payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.axios.patch(`/tags/${id}`, payload)).data;
+        });
+    }
+}
+exports.TagsClient = TagsClient;

package/{src/clients/tags/types/create-tag.ts → dist/clients/tags/types/create-tag.d.ts}

@@ -1,8 +1,7 @@
 export type CreateTagCommand = {
-  name: string
-}
-
+    name: string;
+};
 export type CreateTagResult = {
-  id: string
-  name: string
-}
+    id: string;
+    name: string;
+};

package/dist/clients/tags/types/create-tag.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/clients/tags/types/delete-tag.d.ts

@@ -0,0 +1,4 @@
+export type DeleteTagResult = {
+    id: string;
+    name: string;
+};

package/dist/clients/tags/types/delete-tag.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/clients/tags/types/get-tag.d.ts

@@ -0,0 +1,4 @@
+export type GetTagResult = {
+    id: string;
+    name: string;
+};

package/dist/clients/tags/types/get-tag.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/clients/tags/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from './create-tag';
+export * from './delete-tag';
+export * from './get-tag';
+export * from './list-tags';
+export * from './update-tag';

package/dist/clients/tags/types/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./create-tag"), exports);
+__exportStar(require("./delete-tag"), exports);
+__exportStar(require("./get-tag"), exports);
+__exportStar(require("./list-tags"), exports);
+__exportStar(require("./update-tag"), exports);

package/dist/clients/tags/types/list-tags.d.ts

@@ -0,0 +1,6 @@
+export type ListTagsResult = {
+    data: {
+        id: string;
+        name: string;
+    }[];
+};

package/dist/clients/tags/types/list-tags.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/{src/clients/tags/types/update-tag.ts → dist/clients/tags/types/update-tag.d.ts}

@@ -1,8 +1,7 @@
 export type UpdateTagCommand = {
-  name: string
-}
-
+    name: string;
+};
 export type UpdateTagResult = {
-  id: string
-  name: string
-}
+    id: string;
+    name: string;
+};

package/dist/clients/tags/types/update-tag.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cogfy-messenger.d.ts

@@ -0,0 +1,13 @@
+import { ContactsClient } from './clients/contacts';
+import { TagsClient } from './clients/tags';
+import { ConversationsClient } from './clients/conversations';
+export type CogfyMessengerOptions = {
+    apiKey: string;
+    baseURL?: string;
+};
+export declare class CogfyMessenger {
+    contacts: ContactsClient;
+    conversations: ConversationsClient;
+    tags: TagsClient;
+    constructor(options: CogfyMessengerOptions);
+}

package/dist/cogfy-messenger.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CogfyMessenger = void 0;
+const axios_1 = __importDefault(require("axios"));
+const contacts_1 = require("./clients/contacts");
+const tags_1 = require("./clients/tags");
+const conversations_1 = require("./clients/conversations");
+const DEFAULT_BASE_URL = 'https://messenger-public-api.cogfy.com';
+class CogfyMessenger {
+    constructor(options) {
+        const clientOptions = {
+            axios: axios_1.default.create({
+                baseURL: options.baseURL || DEFAULT_BASE_URL,
+                headers: {
+                    'api-key': options.apiKey
+                }
+            })
+        };
+        this.contacts = new contacts_1.ContactsClient(clientOptions);
+        this.conversations = new conversations_1.ConversationsClient(clientOptions);
+        this.tags = new tags_1.TagsClient(clientOptions);
+    }
+}
+exports.CogfyMessenger = CogfyMessenger;

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './clients';
+export * from './cogfy-messenger';

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./clients"), exports);
+__exportStar(require("./cogfy-messenger"), exports);

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "cogfy-messenger",
-  "version": "0.1.0",
-  "main": "index.js",
+  "version": "0.1.2",
+  "main": "dist/index.js",
   "scripts": {
     "build": "rimraf dist && tsc",
     "prepublishOnly": "npm run build",
     "test": "vitest"
   },
+  "files": [
+    "dist"
+  ],
   "keywords": [],
   "author": "",
   "license": "ISC",

package/.github/workflows/tests.yml

@@ -1,18 +0,0 @@
-on: [push, workflow_dispatch]
-
-jobs:
-  tests:
-    timeout-minutes: 5
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 22.x
-          cache: npm
-          cache-dependency-path: package-lock.json
-      - run: npm ci
-      - run: npm run test
-      - run: npm run build

package/src/clients/base-client.ts

@@ -1,13 +0,0 @@
-import { AxiosInstance } from 'axios'
-
-export type BaseClientOptions = {
-  axios: AxiosInstance
-}
-
-export abstract class BaseClient {
-  protected axios: AxiosInstance
-
-  constructor (options: BaseClientOptions) {
-    this.axios = options.axios
-  }
-}

package/src/clients/contacts/contacts-client.test.ts

@@ -1,89 +0,0 @@
-import AxiosMockAdapter from 'axios-mock-adapter'
-import { afterEach, describe, expect, test } from 'vitest'
-import { CogfyMessenger } from '../../cogfy-messenger'
-import axios from 'axios'
-import { faker } from '@faker-js/faker'
-
-describe('contacts', () => {
-  const mock = new AxiosMockAdapter(axios)
-  const cogfy = new CogfyMessenger({ apiKey: 'test' })
-
-  afterEach(() => {
-    mock.restore()
-  })
-
-  describe('list', () => {
-    test('calls the list endpoint', async () => {
-      mock.onGet('/contacts').reply(200, { data: [{ id: '1' }]})
-
-      const result = await cogfy.contacts.list()
-
-      expect(result).toMatchObject({ data: [{ id: '1' }] })
-    })
-  })
-
-  describe('get', () => {
-    test('calls the get endpoint', async () => {
-      const randomId = faker.string.uuid()
-      mock.onGet(`/contacts/${randomId}`).reply(200, { id: randomId })
-
-      const result = await cogfy.contacts.get(randomId)
-
-      expect(result).toMatchObject({ id: randomId })
-    })
-  })
-
-  describe('create', () => {
-    test('calls the create endpoint', async () => {
-      const randomId = faker.string.uuid()
-      mock.onPost(`/contacts`).reply(201, { id: randomId })
-
-      const result = await cogfy.contacts.create({
-        waProfileName: faker.person.fullName(),
-        firstName: faker.person.firstName(),
-        lastName: faker.person.lastName(),
-        email: faker.internet.email(),
-        phone: faker.phone.number(),
-        occupation: faker.person.jobTitle(),
-        gender: faker.person.gender(),
-        birthdate: faker.date.birthdate().toISOString(),
-        age: faker.number.int({ min: 18, max: 80 }),
-        notes: faker.lorem.sentence()
-      })
-
-      expect(result).toMatchObject({ id: randomId })
-    })
-  })
-
-  describe('delete', () => {
-    test('calls the delete endpoint', async () => {
-      const randomId = faker.string.uuid()
-      mock.onDelete(`/contacts/${randomId}`).reply(200, { id: randomId })
-
-      const result = await cogfy.contacts.delete(randomId)
-
-      expect(result).toMatchObject({ id: randomId })
-    })
-  })
-
-  describe('update', () => {
-    test('calls the update endpoint', async () => {
-      const randomId = faker.string.uuid()
-      mock.onPatch(`/contacts/${randomId}`).reply(200, { id: randomId })
-
-      const result = await cogfy.contacts.update(randomId, {
-        firstName: faker.person.firstName(),
-        lastName: faker.person.lastName(),
-        email: faker.internet.email(),
-        phone: faker.phone.number(),
-        occupation: faker.person.jobTitle(),
-        gender: faker.person.gender(),
-        birthdate: faker.date.birthdate().toISOString(),
-        age: faker.number.int({ min: 18, max: 80 }),
-        notes: faker.lorem.sentence()
-      })
-
-      expect(result).toMatchObject({ id: randomId })
-    })
-  })
-})

package/src/clients/contacts/contacts-client.ts

@@ -1,49 +0,0 @@
-import { BaseClient } from '../base-client'
-import { CreateContactCommand, CreateContactResult, DeleteContactResult, GetContactResult, ListContactsResult, UpdateContactCommand, UpdateContactResult } from './types'
-
-export class ContactsClient extends BaseClient {
-  /**
-   * Calls the POST /contacts endpoint
-   * @param contact The contact data to create
-   * @returns An object with the ID of the newly created contact
-  */
-  async create (contact: CreateContactCommand): Promise<CreateContactResult> {
-    return (await this.axios.post('/contacts', contact)).data
-  }
-
-  /**
-   * Calls the GET /contacts/:id endpoint
-   * @param id The ID of the contact to retrieve
-   * @returns The contact with the specified ID
-  */
-  async get (id: string): Promise<GetContactResult> {
-    return (await this.axios.get(`/contacts/${id}`)).data
-  }
-
-  /**
-   * Calls the GET /contacts endpoint
-   * @returns A list of all contacts in the workspace
-  */
-  async list (): Promise<ListContactsResult> {
-    return (await this.axios.get('/contacts')).data
-  }
-
-  /**
-   * Calls the PATCH /contacts/:id endpoint
-   * @param id The ID of the contact to update
-   * @param contact The updated contact data
-   * @returns An object with the ID of the updated contact
-   */
-  async update (id: string, contact: UpdateContactCommand): Promise<UpdateContactResult> {
-    return (await this.axios.patch(`/contacts/${id}`, contact)).data
-  }
-
-  /**
-   * Calls the DELETE /contacts/:id endpoint
-   * @param id The ID of the contact to delete
-   * @returns An object with the ID of the deleted contact
-  */
-  async delete (id: string): Promise<DeleteContactResult> {
-    return (await this.axios.delete(`/contacts/${id}`)).data
-  }
-}

package/src/clients/contacts/index.ts

@@ -1,2 +0,0 @@
-export * from './contacts-client'
-export * from './types'

package/src/clients/contacts/types/create-contact.ts

@@ -1,16 +0,0 @@
-export type CreateContactResult = {
-  id: string
-}
-
-export type CreateContactCommand = {
-  waProfileName: string | null
-  firstName: string | null
-  lastName: string | null
-  email: string | null
-  phone: string | null
-  occupation: string | null
-  gender: string | null
-  birthdate: string | null
-  age: number | null
-  notes: string | null
-}

package/src/clients/contacts/types/get-contact.ts

@@ -1,18 +0,0 @@
-export type GetContactResult = {
-  id: string
-  workspaceId: string
-  statusId: string | null
-  waId: string | null
-  waProfileName: string | null
-  firstName: string | null
-  lastName: string | null
-  email: string | null
-  phone: string | null
-  occupation: string | null
-  gender: string | null
-  birthdate: string | null
-  age: number | null
-  notes: string | null
-  createDate: string
-  updateDate: string
-}

package/src/clients/contacts/types/index.ts

@@ -1,5 +0,0 @@
-export * from './create-contact'
-export * from './update-contact'
-export * from './get-contact'
-export * from './list-contacts'
-export * from './delete-contact'

package/src/clients/contacts/types/list-contacts.ts

@@ -1,20 +0,0 @@
-export type ListContactsResult = {
-  data: {
-    id: string
-    workspaceId: string
-    statusId: string | null
-    waId: string | null
-    waProfileName: string | null
-    firstName: string | null
-    lastName: string | null
-    email: string | null
-    phone: string | null
-    occupation: string | null
-    gender: string | null
-    birthdate: string | null
-    age: number | null
-    notes: string | null
-    createDate: string
-    updateDate: string
-  }[]
-}

package/src/clients/contacts/types/update-contact.ts

@@ -1,15 +0,0 @@
-export type UpdateContactCommand = {
-  firstName: string | null
-  lastName: string | null
-  email: string | null
-  phone: string | null
-  occupation: string | null
-  gender: string | null
-  birthdate: string | null
-  age: number | null
-  notes: string | null
-}
-
-export type UpdateContactResult = {
-  id: string
-}

package/src/clients/conversations/conversations-client.test.ts

@@ -1,56 +0,0 @@
-import AxiosMockAdapter from 'axios-mock-adapter'
-import { ConversationsClient } from './conversations-client'
-import axios from 'axios'
-import { CogfyMessenger } from '../../cogfy-messenger'
-import { faker } from '@faker-js/faker'
-import { describe, expect, it, beforeEach } from 'vitest'
-
-describe(ConversationsClient, () => {
-  const axiosMock = new AxiosMockAdapter(axios)
-  const cogfy = new CogfyMessenger({ apiKey: 'test' })
-
-  beforeEach(() => {
-    axiosMock.restore()
-  })
-
-  describe(ConversationsClient.prototype.get, () => {
-    it('should call GET /conversations/:id endpoint', async () => {
-      const id = faker.string.uuid()
-      const name = faker.lorem.word()
-      axiosMock.onGet(`/conversations/${id}`).reply(200, { id, name })
-
-      const result = await cogfy.conversations.get(id)
-
-      expect(result).toEqual({ id, name })
-    })
-  })
-
-  describe(ConversationsClient.prototype.list, () => {
-    it('should call GET /conversations endpoint', async () => {
-      const conversations = Array.from({ length: 3 }, () => ({
-        id: faker.string.uuid(),
-        name: faker.lorem.word()
-      }))
-      axiosMock.onGet('/conversations').reply(200, { data: conversations })
-
-      const result = await cogfy.conversations.list({ phoneNumberId: faker.string.uuid() })
-
-      expect(result.data).toEqual(conversations)
-    })
-  })
-
-  describe('send message', () => {
-    it('calls the send message endpoint', async () => {
-      const conversationId = faker.string.uuid()
-      const messageId = faker.string.uuid()
-      axiosMock.onPost(`/conversations/${conversationId}/messages`).reply(201, { id: messageId })
-
-      const result = await cogfy.conversations.sendMessage(conversationId, {
-        type: 'text',
-        content: faker.lorem.sentence()
-      })
-
-      expect(result).toMatchObject({ id: messageId })
-    })
-  })
-})

package/src/clients/conversations/conversations-client.ts

@@ -1,41 +0,0 @@
-import { BaseClient } from '../base-client'
-import { SendMessageCommand } from './types/send-message'
-import { GetConversationResult, GetMessagesResult, ListConversationsParams, ListConversationsResult, ListMessagesParams } from './types'
-
-export class ConversationsClient extends BaseClient {
-  /**
-   * Calls the GET /conversations/:id endpoint
-   * @param id The ID of the conversation to retrieve
-   * @returns The conversation with the specified ID
-  */
-  async get (id: string): Promise<GetConversationResult> {
-    return (await this.axios.get(`/conversations/${id}`)).data
-  }
-
-  /**
-   * Calls the GET /conversations endpoint
-   * @param params Params for listing conversations, such as pagination cursors
-   * @returns A list of all conversations in the workspace
-  */
-  async list (params: ListConversationsParams): Promise<ListConversationsResult> {
-    const axiosResponse = await this.axios.get(`/conversations`, {
-      params,
-    })
-    return axiosResponse.data
-  }
-
-  /**
-   * Calls the GET /conversations/:id/messages endpoint
-   * @param params Params for listing messages in a conversation, such as pagination cursors
-   * @returns A list of all messages in the specified conversation
-  */
-  async getMessages (params: ListMessagesParams): Promise<GetMessagesResult> {
-    const axiosResponse = await this.axios.get(`/conversations/${params.conversationId}/messages`, {
-      params
-    })
-    return axiosResponse.data
-  }
-  async sendMessage (id: string, payload: SendMessageCommand): Promise<any> {
-    return (await this.axios.post(`/conversations/${id}/messages`, payload)).data
-  }
-}

package/src/clients/conversations/index.ts

@@ -1,2 +0,0 @@
-export * from './conversations-client'
-export * from './types'

package/src/clients/conversations/types/get-conversation.ts

@@ -1,11 +0,0 @@
-export type GetConversationResult = {
-  id: string
-  workspaceId: string
-  phoneNumberId: string | null
-  recipientId: string | null
-  assigneeId: string | null
-  lastMessageId: string | null
-  data: any | null
-  createDate: string
-  serviceWindowExpireDate: string | null
-}

package/src/clients/conversations/types/get-messages.ts

@@ -1,35 +0,0 @@
-export type GetMessagesResult = {
-  data: {
-    id: string
-    workspaceId: string
-    conversationId: string | null
-    assistantId: string | null
-    userId: string | null
-    broadcastId: string | null
-    whatsappMessageId: string | null
-    from: string | null
-    to: string | null
-    role: string
-    status: string | null
-    type: string | null
-    content: string | null
-    contentData: string | null
-    toolCallId: string | null
-    toolCalls: string | null
-    data: string | null
-    contextId: string | null
-    contextFrom: string | null
-    createDate: Date
-    sendDate: Date
-    deliverDate: Date | null
-    readDate: Date | null
-    promptTokens: number | null
-    completionTokens: number | null
-    order: number
-    traceId: string | null
-  }[]
-  cursors: {
-    next: string | null
-    prev: string | null
-  }
-}

package/src/clients/conversations/types/index.ts

@@ -1,4 +0,0 @@
-export * from './get-conversation'
-export * from './get-messages'
-export * from './send-message'
-export * from './list-conversations'