@dawntech/blip-tools 0.2.0 → 0.3.1

package/dist/index.d.ts

@@ -7,10 +7,12 @@ import { Ticket } from './types/ticket.js';
 import { CampaignNotification } from './types/campaign-notification.js';
 import { CampaignNotificationStatus } from './types/campaign-notification-status.js';
 import BlipBucket from './modules/blip-bucket.js';
+import BlipMedia from './modules/blip-media.js';
 export { BlipError, type Ticket, type AttendanceHourContainer, type Contact, type Template };
 export default class Blip {
     private api;
     bucket: BlipBucket;
+    media: BlipMedia;
     constructor(params: BlipConstructor);
     /**
      * Sends a template-based message to any user. For sending messages to clients who are active, use `sendTemplateMessage` instead.
@@ -38,21 +40,39 @@ export default class Blip {
     /**
      * 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 }: {
+    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 }: {
+    sendSimpleMessage({ identity, content, metadata }: {
         identity: string;
         content: string;
+        metadata?: string;
     }): Promise<void>;
-    sendMessageWithButtons({ identity, message, buttons, }: {
+    /**
+     * 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>;
     updateContact({ identity, contactData }: {
         identity: string;
@@ -67,6 +87,12 @@ export default class Blip {
         value: unknown;
         identity: string;
     }): Promise<void>;
+    moveUser({ identity, botIdentity, botFlowId, botStateId, }: {
+        identity: string;
+        botIdentity: string;
+        botFlowId: string;
+        botStateId: string;
+    }): Promise<void>;
     getWhatsAppIdentity(phone: string): Promise<string>;
     createTrackEvent({ category, action, identity }: {
         category: string;

package/dist/index.js

@@ -7,10 +7,12 @@ import validateInstance from './helpers/validate-instance.js';
 import BlipError from './exceptions/blip-error.js';
 import encodeBlipParams from './helpers/encode-blip-params.js';
 import BlipBucket from './modules/blip-bucket.js';
+import BlipMedia from './modules/blip-media.js';
 export { BlipError };
 export default class Blip {
     api;
     bucket;
+    media;
     constructor(params) {
         validateInstance(params);
         this.api = axios.create({
@@ -21,6 +23,7 @@ export default class Blip {
             timeout: 30000,
         });
         this.bucket = new BlipBucket(this.api);
+        this.media = new BlipMedia(this.api);
     }
     /**
      * Sends a template-based message to any user. For sending messages to clients who are active, use `sendTemplateMessage` instead.
@@ -111,7 +114,7 @@ export default class Blip {
     /**
      * Sends a template-based message to an active user. For sending messages to clients who have never interacted or are inactive, use `sendTemplate` instead.
      */
-    async sendTemplateMessage({ identity, template }) {
+    async sendTemplateMessage({ identity, template, metadata, }) {
         try {
             const response = await this.api.post('/messages', {
                 id: randomUUID(),
@@ -121,6 +124,7 @@ export default class Blip {
                     type: 'template',
                     template,
                 },
+                metadata,
             });
             validateResponse(response);
         }
@@ -131,13 +135,14 @@ export default class Blip {
     /**
      * Sends a simple text message to an active user. For sending messages to clients who have never interacted or are inactive, use `sendTemplate` instead.
      */
-    async sendSimpleMessage({ identity, content }) {
+    async sendSimpleMessage({ identity, content, metadata }) {
         try {
             const response = await this.api.post('/messages', {
                 id: randomUUID(),
                 to: identity,
                 type: 'text/plain',
                 content,
+                metadata,
             });
             validateResponse(response);
         }
@@ -145,7 +150,33 @@ export default class Blip {
             handleError(error);
         }
     }
-    async sendMessageWithButtons({ identity, message, buttons, }) {
+    /**
+     * 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.
+     */
+    async sendMediaMessage({ identity, text, metadata, uri, type, title, aspectRatio = '1:1', size, previewUri, }) {
+        try {
+            const response = await this.api.post('/messages', {
+                id: randomUUID(),
+                to: identity,
+                type: 'application/vnd.lime.media-link+json',
+                content: {
+                    text,
+                    uri,
+                    type,
+                    title,
+                    aspectRatio,
+                    size,
+                    previewUri,
+                },
+                metadata,
+            });
+            validateResponse(response);
+        }
+        catch (error) {
+            handleError(error);
+        }
+    }
+    async sendMessageWithButtons({ identity, message, buttons, metadata, }) {
         try {
             const response = await this.api.post('/messages', {
                 id: randomUUID(),
@@ -156,6 +187,7 @@ export default class Blip {
                     text: message,
                     options: buttons.map((button, index) => ({ order: index + 1, text: button })),
                 },
+                metadata,
             });
             validateResponse(response);
         }
@@ -228,6 +260,12 @@ export default class Blip {
             handleError(error);
         }
     }
+    async moveUser({ identity, botIdentity, botFlowId, botStateId, }) {
+        await Promise.all([
+            this.setContextVariable({ identity, variableName: 'master-state', value: botIdentity }),
+            this.setContextVariable({ identity, variableName: `stateid@${botFlowId}`, value: botStateId }),
+        ]);
+    }
     async getWhatsAppIdentity(phone) {
         try {
             const response = await this.api.post('/commands', {

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

@@ -0,0 +1,17 @@
+import { AxiosInstance } from 'axios';
+export default class BlipMedia {
+    private api;
+    constructor(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
+     * @returns A public URL
+     */
+    uploadMedia(content: Blob): Promise<string>;
+    /**
+     * 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
+     */
+    refreshMediaUri(expiredMediaUri: string): Promise<string>;
+}

package/dist/modules/blip-media.js

@@ -0,0 +1,55 @@
+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);
+        }
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dawntech/blip-tools",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "Node package for Blip API",
   "main": "dist/index.js",
   "module": "dist/index.js",