@dawntech/blip-tools 0.3.1 → 0.4.0

package/dist/modules/blip-dispatch.d.ts

@@ -0,0 +1,63 @@
+import { AxiosInstance } from 'axios';
+import { CampaignNotification } from '../types/campaign-notification';
+import { CampaignNotificationStatus } from '../types/campaign-notification-status';
+import { Template } from '../types/template';
+export default class BlipDispatch {
+    private api;
+    constructor(context: {
+        api: AxiosInstance;
+    });
+    /**
+     * Sends a template-based message to any user. For sending messages to clients who are active, use `sendTemplateMessage` instead.
+     */
+    sendIndividualActiveCampaign({ campaignName, masterState, flowId, stateId, channelType, phone, templateName, params, }: {
+        campaignName: string;
+        masterState: string;
+        flowId: string;
+        stateId: string;
+        channelType: string;
+        phone: string;
+        templateName: string;
+        params: string[];
+    }): Promise<CampaignNotification>;
+    getCampaignNotificationStatus({ campaignNotificationId }: {
+        campaignNotificationId: string;
+    }): Promise<CampaignNotificationStatus[]>;
+    /**
+     * Sends a template-based message to an active user. For sending messages to clients who have never interacted or are inactive, use `sendTemplate` instead.
+     */
+    sendTemplateMessage({ identity, template, metadata, }: {
+        identity: string;
+        template: Template;
+        metadata?: string;
+    }): Promise<void>;
+    /**
+     * Sends a simple text message to an active user. For sending messages to clients who have never interacted or are inactive, use `sendTemplate` instead.
+     */
+    sendSimpleMessage({ identity, content, metadata }: {
+        identity: string;
+        content: string;
+        metadata?: string;
+    }): Promise<void>;
+    /**
+     * Sends a text message to an active user with a midia. For sending messages to clients who have never interacted or are inactive, use `sendTemplate` instead.
+     */
+    sendMediaMessage({ identity, text, metadata, uri, type, title, aspectRatio, size, previewUri, }: {
+        type?: string;
+        uri: string;
+        identity: string;
+        text: string;
+        metadata?: string;
+        title: string;
+        aspectRatio?: string;
+        size?: number;
+        previewUri?: string;
+        previewType?: string;
+    }): Promise<void>;
+    sendMessageWithButtons({ identity, message, buttons, metadata, }: {
+        identity: string;
+        message: string;
+        buttons: string[];
+        metadata?: string;
+    }): Promise<void>;
+}

package/dist/modules/blip-event.d.ts

@@ -0,0 +1,12 @@
+import { AxiosInstance } from 'axios';
+export default class BlipEvent {
+    private api;
+    constructor(context: {
+        api: AxiosInstance;
+    });
+    createTrackEvent({ category, action, identity }: {
+        category: string;
+        action: string;
+        identity?: string;
+    }): Promise<void>;
+}

package/dist/modules/blip-interaction.d.ts

@@ -0,0 +1,13 @@
+import BlipContext from './blip-context';
+export default class BlipInteraction {
+    private blipContext;
+    constructor(context: {
+        blipContext: BlipContext;
+    });
+    moveUser({ identity, botIdentity, botFlowId, botStateId, }: {
+        identity: string;
+        botIdentity: string;
+        botFlowId: string;
+        botStateId: string;
+    }): Promise<void>;
+}

package/dist/modules/blip-main.d.ts

@@ -0,0 +1,25 @@
+import BlipBucket from './blip-bucket';
+import BlipMedia from './blip-media';
+import type { BlipConstructor } from '../types/blip-constructor';
+import BlipAttendance from './blip-attendance';
+import BlipContext from './blip-context';
+import BlipDispatch from './blip-dispatch';
+import BlipEvent from './blip-event';
+import BlipInteraction from './blip-interaction';
+import BlipTicket from './blip-ticket';
+import BlipWhatsapp from './blip-whatsapp';
+import BlipContact from './blip-contact';
+export declare class Blip {
+    private api;
+    bucket: BlipBucket;
+    media: BlipMedia;
+    attendance: BlipAttendance;
+    contact: BlipContact;
+    context: BlipContext;
+    dispatch: BlipDispatch;
+    event: BlipEvent;
+    interaction: BlipInteraction;
+    ticket: BlipTicket;
+    whatsapp: BlipWhatsapp;
+    constructor(params: BlipConstructor);
+}

package/dist/modules/blip-media.d.ts

@@ -1,7 +1,9 @@
 import { AxiosInstance } from 'axios';
 export default class BlipMedia {
     private api;
-    constructor(api: AxiosInstance);
+    constructor(context: {
+        api: AxiosInstance;
+    });
     /**
      * Uploads an media file to Blip storage to be used later when sending messages
      * @param content A Blob containing a image, PDF or video

package/dist/modules/blip-ticket.d.ts

@@ -0,0 +1,12 @@
+import { AxiosInstance } from 'axios';
+export default class BlipTicket {
+    private api;
+    constructor(context: {
+        api: AxiosInstance;
+    });
+    search({ filter, skip, take }: {
+        filter?: string;
+        skip?: number;
+        take?: number;
+    }): Promise<import("../types").Ticket[]>;
+}

package/dist/modules/blip-whatsapp.d.ts

@@ -0,0 +1,10 @@
+import { AxiosInstance } from 'axios';
+import { Template } from '../types/template';
+export default class BlipWhatsapp {
+    private api;
+    constructor(context: {
+        api: AxiosInstance;
+    });
+    getTemplates(): Promise<Template[]>;
+    getIdentity(phone: string): Promise<string>;
+}

package/dist/modules/index.d.ts

@@ -0,0 +1,11 @@
+import BlipBucket from './blip-bucket';
+import BlipMedia from './blip-media';
+import BlipAttendance from './blip-attendance';
+import BlipContact from './blip-contact';
+import BlipContext from './blip-context';
+import BlipDispatch from './blip-dispatch';
+import BlipEvent from './blip-event';
+import BlipInteraction from './blip-interaction';
+import BlipTicket from './blip-ticket';
+import BlipWhatsapp from './blip-whatsapp';
+export { BlipMedia, BlipBucket, BlipAttendance, BlipContact, BlipContext, BlipDispatch, BlipEvent, BlipInteraction, BlipTicket, BlipWhatsapp, };

package/dist/types/attendance-hour-container.d.ts

@@ -0,0 +1,25 @@
+export interface AttendanceHourContainer {
+    attendanceHour: {
+        id: string;
+        title: string;
+        description: string;
+        isMain: boolean;
+        ownerIdentity: string;
+        storageDate: string;
+        modifyDate: string;
+        timeZoneId: string;
+    };
+    attendanceHourScheduleItems: {
+        id: string;
+        startTime: string;
+        endTime: string;
+        dayOfWeek: string;
+    }[];
+    attendanceHourOffItems: {
+        id: string;
+        reason: string;
+        startDate: string;
+        endDate: string;
+    }[];
+    queues: [];
+}

package/dist/types/blip-constructor.d.ts

@@ -0,0 +1,4 @@
+export interface BlipConstructor {
+    contract: string;
+    authToken: string;
+}

package/dist/types/blip.d.ts

@@ -0,0 +1,26 @@
+export interface BlipRequestBody {
+    id: string;
+    to?: string;
+    method: string;
+    uri: string;
+    type?: string;
+    resource?: unknown;
+}
+export interface BlipResponse<T> {
+    type: string;
+    resource: T;
+    method: string;
+    status: string;
+    id: string;
+    from: string;
+    to: string;
+    metadata: {
+        traceparent: string;
+        '#command.uri': string;
+    };
+}
+export interface BlipArrayBody<T> {
+    total: number;
+    itemType: string;
+    items: T[];
+}

package/dist/types/campaign-notification-status.d.ts

@@ -0,0 +1,21 @@
+export interface CampaignNotificationStatus {
+    event: string;
+    reason: {
+        code: number;
+        description: string;
+    };
+    id: string;
+    from: string;
+    to: string;
+    metadata: {
+        traceparent: string;
+        '#envelope.timestamp': string;
+        '#wa.timestamp'?: string;
+        '#message.uniqueId': string;
+        '#wa.conversation.origin.type'?: string;
+        '#wa.conversation.id'?: string;
+        '#message.to'?: string;
+        '#message.from'?: string;
+        '#envelope.storageDate': string;
+    };
+}

package/dist/types/campaign-notification.d.ts

@@ -0,0 +1,14 @@
+export interface CampaignNotification {
+    id: string;
+    name: string;
+    campaignType: string;
+    masterState: string;
+    flowId: string;
+    stateId: string;
+    status: string;
+    created: string;
+    tags: string[];
+    isToUseLiteApi: boolean;
+    channelType: string;
+    canSendWithOpenTicket: boolean;
+}

package/dist/types/campaing-request.d.ts

@@ -0,0 +1,26 @@
+export interface CampaignRequestBody {
+    id: string;
+    to: string;
+    method: string;
+    uri: string;
+    type: string;
+    resource: {
+        campaign: {
+            name: string;
+            campaignType: string;
+            masterState: string;
+            flowId: string;
+            stateId: string;
+            channelType: string;
+        };
+        audience: {
+            recipient: string;
+            messageParams?: Record<string, string>;
+        };
+        message: {
+            messageTemplate: string;
+            messageParams?: string[];
+            channelType: string;
+        };
+    };
+}

package/dist/types/contact.d.ts

@@ -0,0 +1,8 @@
+export interface Contact {
+    lastMessageDate: string;
+    lastUpdateDate: string;
+    identity: string;
+    phoneNumber: string;
+    extras: Record<string, string>;
+    source: string;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,7 @@
+import { AttendanceHourContainer } from './attendance-hour-container';
+import { BlipConstructor } from './blip-constructor';
+import { BlipRequestBody, BlipResponse, BlipArrayBody } from './blip';
+import { Parameter, Component, Template } from './template';
+import { TicketSearchResult } from './ticket-search-result';
+import { Ticket } from './ticket';
+export { AttendanceHourContainer, BlipConstructor, BlipRequestBody, BlipResponse, BlipArrayBody, Parameter, Component, Template, TicketSearchResult, Ticket, };

package/dist/types/template.d.ts

@@ -0,0 +1,18 @@
+export interface Parameter {
+    type: 'text';
+    text: string;
+}
+export interface Component {
+    type: 'body' | 'button';
+    sub_type?: 'url';
+    index?: number;
+    parameters: Parameter[];
+}
+export interface Template {
+    name: string;
+    language: {
+        code: string;
+        policy: string;
+    };
+    components: Component[] | string[];
+}

package/dist/types/ticket-search-result.d.ts

@@ -0,0 +1,6 @@
+import { Ticket } from './ticket';
+export interface TicketSearchResult {
+    total: number;
+    itemType: string;
+    items: Ticket[];
+}

package/dist/types/ticket.d.ts

@@ -0,0 +1,17 @@
+export interface Ticket {
+    id: string;
+    sequentialId: number;
+    ownerIdentity: string;
+    customerIdentity: string;
+    customerDomain: string;
+    provider: string;
+    status: string;
+    storageDate: string;
+    externalId: string;
+    rating: number;
+    team: string;
+    unreadMessages: number;
+    closed: boolean;
+    priority: number;
+    CampaignId?: string;
+}

package/package.json

@@ -1,13 +1,25 @@
 {
   "name": "@dawntech/blip-tools",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Node package for Blip API",
-  "main": "dist/index.js",
-  "module": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "default": "./dist/index.mjs",
+        "types": "./dist/index.d.ts"
+      },
+      "require": {
+        "default": "./dist/index.cjs",
+        "types": "./dist/index.d.ts"
+      }
+    },
+    "./types": {
+      "types": "./dist/types/index.d.ts"
+    }
+  },
   "type": "module",
   "scripts": {
-    "build": "tsc",
+    "build": "rollup --config rollup.config.js",
     "lint": "eslint . --ignore-pattern 'dist/*'",
     "lint:fix": "eslint . --fix --ignore-pattern 'dist/*'",
     "format": "prettier --check 'src/**/*.ts'",
@@ -30,10 +42,13 @@
   "license": "MIT",
   "devDependencies": {
     "@eslint/js": "^9.22.0",
+    "@rollup/plugin-typescript": "^12.1.4",
     "@types/node": "^22.13.10",
     "@typescript-eslint/eslint-plugin": "^8.26.0",
     "eslint": "^9.22.0",
     "prettier": "^3.5.3",
+    "rollup": "^4.50.2",
+    "tslib": "^2.8.1",
     "typescript": "^5.8.2",
     "typescript-eslint": "^8.26.0"
   },

package/dist/exceptions/blip-error.js

@@ -1,7 +0,0 @@
-export default class BlipError extends Error {
-    code;
-    constructor(message, code = 0) {
-        super(message);
-        this.code = code;
-    }
-}

package/dist/helpers/encode-blip-params.js

@@ -1,11 +0,0 @@
-import encodeString from './encode-strings.js';
-export default function encodeBlipParams(params) {
-    //This function does not uses any of the standard methods of URI parsing because Blip does not follow any of them
-    const parsedParams = [];
-    for (const [key, value] of Object.entries(params)) {
-        if (value && key) {
-            parsedParams.push(`${encodeString(key)}=${encodeString(value)}`);
-        }
-    }
-    return parsedParams.join('&');
-}

package/dist/helpers/encode-strings.js

@@ -1,3 +0,0 @@
-export default function encodeString(value) {
-    return String(value).replaceAll(' ', '%20');
-}

package/dist/helpers/format-template-params.js

@@ -1,6 +0,0 @@
-export default function formatTemplateParams(params) {
-    return params.reduce((prev, current, index) => {
-        prev[index + 1] = current;
-        return prev;
-    }, {});
-}

package/dist/helpers/handle-error.js

@@ -1,14 +0,0 @@
-import { AxiosError } from 'axios';
-import BlipError from '../exceptions/blip-error.js';
-export default function handleError(error) {
-    if (error instanceof BlipError) {
-        throw error;
-    }
-    if (error instanceof AxiosError) {
-        if (error.response?.data.code) {
-            throw new BlipError(error.response?.data.description, error.response?.data.code);
-        }
-        throw new BlipError(error.message, 0);
-    }
-    throw error;
-}

package/dist/helpers/validate-instance.js

@@ -1,9 +0,0 @@
-import BlipError from '../exceptions/blip-error.js';
-export default function validateInstance(params) {
-    if (!params.contract) {
-        throw new BlipError('A contract must be specified.');
-    }
-    if (!params.authToken) {
-        throw new BlipError('An authToken must be provided.');
-    }
-}

package/dist/helpers/validate-response.js

@@ -1,6 +0,0 @@
-import BlipError from '../exceptions/blip-error.js';
-export default function validateResponse(response) {
-    if (response.data.status === 'failure') {
-        throw new BlipError(response.data.reason.description, response.data.reason.code);
-    }
-}

package/dist/modules/blip-bucket.js

@@ -1,88 +0,0 @@
-import encodeString from '../helpers/encode-strings.js';
-import { randomUUID } from 'crypto';
-import encodeBlipParams from '../helpers/encode-blip-params.js';
-import validateResponse from '../helpers/validate-response.js';
-import handleError from '../helpers/handle-error.js';
-export default class BlipBucket {
-    api;
-    constructor(api) {
-        this.api = api;
-    }
-    /**
-        Stores JSON content in a bucket provided by Blip. The content can be updaded or retrieved using the same id used in the update.
-        You can optionally provide a expiration time (in milliseconds) to delete the document after a certain amount of time.
-    */
-    async storeContentInBucket(id, content, opts) {
-        try {
-            let uri = `/buckets/${encodeString(id)}`;
-            const params = {};
-            if (opts?.expiresInMs) {
-                params.expiration = opts?.expiresInMs;
-                uri += `?${encodeBlipParams(params)}`;
-            }
-            const body = {
-                id: randomUUID(),
-                method: 'set',
-                type: 'application/json',
-                uri,
-                resource: content,
-            };
-            const response = await this.api.post('/commands', body);
-            validateResponse(response);
-        }
-        catch (error) {
-            throw handleError(error);
-        }
-    }
-    /**
-        Retrieves a document from the Blip bucket.
-    */
-    async getContentFromBucket(id) {
-        try {
-            const body = {
-                id: randomUUID(),
-                method: 'get',
-                uri: `/buckets/${encodeString(id)}`,
-            };
-            const response = await this.api.post('/commands', body);
-            validateResponse(response);
-            return response.data.resource;
-        }
-        catch (error) {
-            throw handleError(error);
-        }
-    }
-    async getAllContentIdsFromBucket() {
-        try {
-            const body = {
-                id: randomUUID(),
-                method: 'get',
-                uri: `/buckets`,
-            };
-            const response = await this.api.post('/commands', body);
-            validateResponse(response);
-            return response.data.resource.items;
-        }
-        catch (error) {
-            throw handleError(error);
-        }
-    }
-    /**
-        Deletes a JSON document from the Blip bucket.
-    */
-    async deleteContentFromBucket(id) {
-        try {
-            const body = {
-                id: randomUUID(),
-                method: 'delete',
-                uri: `/buckets/${encodeString(id)}`,
-                to: 'postmaster@msging.net',
-            };
-            const response = await this.api.post('/commands', body);
-            validateResponse(response);
-        }
-        catch (error) {
-            throw handleError(error);
-        }
-    }
-}

package/dist/modules/blip-media.js

@@ -1,55 +0,0 @@
-import axios from 'axios';
-import { randomUUID } from 'crypto';
-import validateResponse from '../helpers/validate-response.js';
-import handleError from '../helpers/handle-error.js';
-export default class BlipMedia {
-    api;
-    constructor(api) {
-        this.api = api;
-    }
-    /**
-     * Uploads an media file to Blip storage to be used later when sending messages
-     * @param content A Blob containing a image, PDF or video
-     * @returns A public URL
-     */
-    async uploadMedia(content) {
-        try {
-            const response = await this.api.post('/commands', {
-                id: randomUUID(),
-                to: 'postmaster@media.msging.net',
-                method: 'get',
-                uri: '/upload-media-uri',
-            });
-            validateResponse(response);
-            const uploadResponse = await axios.post(response.data.resource, content, {
-                headers: { 'Content-Type': 'application/octet-stream' },
-            });
-            return uploadResponse.data.mediaUri;
-        }
-        catch (error) {
-            throw handleError(error);
-        }
-    }
-    /**
-     * Generates a new public URI to access blip chat media. Blip medias have expiration dates so you need to generate new ones to access the data.
-     * @param expiredMediaUri Blip media expired URI
-     * @returns A new public URI
-     */
-    async refreshMediaUri(expiredMediaUri) {
-        try {
-            const response = await this.api.post('/commands', {
-                id: randomUUID(),
-                to: 'postmaster@media.msging.net',
-                method: 'set',
-                type: 'text/plain',
-                uri: '/refresh-media-uri',
-                resource: expiredMediaUri,
-            });
-            validateResponse(response);
-            return response.data.resource;
-        }
-        catch (error) {
-            throw handleError(error);
-        }
-    }
-}