@whitewall/blip-sdk 0.0.164 → 0.0.166

package/src/namespaces/account.ts

@@ -48,6 +48,7 @@ export class AccountNamespace extends Namespace {
         )
     }
 
+    /** If you are initializing a chatbot, it usually is status 'available' with routingRule 'identity' */
     public async setPresence(presence: Omit<Presence, 'lastSeen' | 'instances'>, opts?: ConsumeOptions): Promise<void> {
         return await this.sendCommand(
             {
@@ -221,6 +222,7 @@ export class AccountNamespace extends Namespace {
     }
 
     public async *streamContacts(filter?: ODataFilter<Contact>, opts?: ConsumeOptions): AsyncIterable<Contact> {
+        const take = opts?.take ?? 100
         const items = this.sendCommand<'get', Array<Contact>>(
             {
                 method: 'get',
@@ -230,13 +232,22 @@ export class AccountNamespace extends Namespace {
                 collection: true,
                 stream: true,
                 ...opts,
+                take,
             },
         )
 
-        const seenIdentities = new Set<string | number>()
+        const seenIdentities = new Map<string, true>()
+        // best-effort to deduplicate without growing memory indefinitely
+        const maxIdentityCacheSize = take * 5
+
         for await (const contact of items) {
             if (!seenIdentities.has(contact.identity)) {
-                seenIdentities.add(contact.identity)
+                seenIdentities.set(contact.identity, true)
+
+                if (seenIdentities.size > maxIdentityCacheSize) {
+                    seenIdentities.delete(seenIdentities.keys().next().value!)
+                }
+
                 yield contact
             }
         }
@@ -252,7 +263,10 @@ export class AccountNamespace extends Namespace {
         const end = new Date(endDate)
         if (start > end) return
 
-        const seenNames = new Set<string>()
+        const seenNames = new Map<string, true>()
+        // best-effort to deduplicate without growing memory indefinitely
+        const maxNameCacheSize = take * 5
+        let yieldedCount = 0
         let cursorTime = end.getTime()
         const startTime = start.getTime()
 
@@ -282,17 +296,23 @@ export class AccountNamespace extends Namespace {
 
                     const name = Node.from(contact.identity).name
                     if (!seenNames.has(name)) {
-                        seenNames.add(name)
+                        seenNames.set(name, true)
+
+                        if (seenNames.size > maxNameCacheSize) {
+                            seenNames.delete(seenNames.keys().next().value!)
+                        }
+
                         yield contact
+                        yieldedCount++
 
-                        if (opts.max && seenNames.size >= opts.max) {
+                        if (opts.max && yieldedCount >= opts.max) {
                             return
                         }
                     }
                 }
             }
 
-            const reachedMax = opts.max && seenNames.size >= opts.max
+            const reachedMax = opts.max && yieldedCount >= opts.max
             const hasMore = !reachedMax && count === take && cursorTime !== oldestTime - 1
             if (!hasMore || !opts.fetchall) break
 
@@ -560,7 +580,7 @@ export class AccountNamespace extends Namespace {
         },
         opts?: Omit<ConsumeOptions, 'skip'>,
     ): Promise<Array<ThreadItem>> {
-        let thread: Array<ThreadItem> = []
+        const thread: Array<ThreadItem> = []
         let lastMessage = query?.messageId
         let lastStorageDate = query?.referenceDate ? new Date(query.referenceDate).toISOString() : undefined
         let hasMore = true
@@ -593,14 +613,14 @@ export class AccountNamespace extends Namespace {
                     fetchall: false,
                 },
             )
-            thread = [...thread, ...threadItems]
+            thread.push(...threadItems)
 
             hasMore = threadItems.length === take && lastMessage !== threadItems.at(-1)?.id
             lastMessage = threadItems.at(-1)?.id
             lastStorageDate = threadItems.at(-1)?.date
         } while (hasMore && opts?.fetchall)
 
-        return thread.toSorted((a, b) => b.date.localeCompare(a.date))
+        return thread.sort((a, b) => b.date.localeCompare(a.date))
     }
 
     public async getNotifications(

package/src/namespaces/namespace.ts

@@ -127,7 +127,7 @@ export class Namespace {
             for (const item of items) {
                 yield item
 
-                if (options.max && yielded++ >= options.max) {
+                if (options.max !== undefined && ++yielded >= options.max) {
                     return
                 }
             }

package/src/namespaces/plugins.ts

@@ -1,7 +1,7 @@
 import type { BlipClient } from '../client.ts'
 import type { BlipLanguage } from '../types/account.ts'
 import type { Identity } from '../types/node.ts'
-import type { DetailedPlugin, Plugin, PluginSubscription } from '../types/plugins.ts'
+import type { DetailedPlugin, Plugin, PluginBilling, PluginSubscription } from '../types/plugins.ts'
 import type { Application } from '../types/portal.ts'
 import { uri } from '../utils/uri.ts'
 import { type ConsumeOptions, Namespace, type SendCommandOptions } from './namespace.ts'
@@ -221,11 +221,156 @@ export class PluginsNamespace extends Namespace {
         )
     }
 
+    /** This route can only be called by an admin user of blip.ai */
+    public deletePluginMedia(mediaId: string, opts?: ConsumeOptions) {
+        return this.sendCommand(
+            {
+                method: 'delete',
+                uri: uri`/images/${mediaId}`,
+            },
+            opts,
+        )
+    }
+
+    /** This route can only be called by an admin user of blip.ai */
+    public addPluginMedia(pluginId: string, type: 'image' | 'video', url: string, opts?: ConsumeOptions) {
+        return this.sendCommand(
+            {
+                method: 'set',
+                type: 'application/vnd.iris.plugins.image-create+json',
+                uri: uri`/images`,
+                resource: {
+                    uri: url,
+                    pluginId,
+                    imageType: type === 'image' ? 3 : 1,
+                },
+            },
+            opts,
+        )
+    }
+
+    /** This route can only be called by an admin user of blip.ai */
+    public addPlugin(
+        plugin: {
+            documentation: DetailedPlugin['documentation']
+            url: string
+            icon: DetailedPlugin['icon']
+            price?: DetailedPlugin['price']
+            authorId: number
+            media: Array<{ uri: string; type: 'image' | 'video' }>
+            tags: Array<number>
+            languages: {
+                pt: {
+                    name: string
+                    overview: string
+                    description: string
+                }
+                en: {
+                    name: string
+                    overview: string
+                    description: string
+                }
+                es: {
+                    name: string
+                    overview: string
+                    description: string
+                }
+            }
+            prices?: Array<
+                Omit<PluginBilling, 'billingId' | 'currency' | 'language' | 'isActive' | 'featuresIncluded'> & {
+                    featuresIncluded: Array<{
+                        icon: string
+                        description: string
+                    }>
+                }
+            >
+        },
+        opts?: ConsumeOptions,
+    ) {
+        const price = plugin.prices?.[0]?.price ?? plugin.price
+        return this.sendCommand(
+            {
+                method: 'set',
+                type: 'application/vnd.lime.collection+json',
+                uri: uri`/plugins`,
+                resource: {
+                    itemType: 'application/vnd.iris.plugin.resource+json',
+                    items: [
+                        {
+                            name: plugin.languages.pt.name,
+                            website: plugin.documentation,
+                            url: plugin.url,
+                            overview: plugin.languages.pt.overview,
+                            description: plugin.languages.pt.description,
+                            version: '1.0.0',
+                            icon: plugin.icon,
+                            isPaid: price !== undefined && price > 0,
+                            price,
+                            authorId: plugin.authorId,
+                            installationType: 0,
+                            configurationLink: '/application/detail/{botId}/plugin/{pluginId}',
+                            pluginType: 'Frontend',
+                            images: plugin.media.map((m) => ({
+                                language: 'pt',
+                                uri: m.uri,
+                                imageType: m.type === 'image' ? 3 : 1,
+                            })),
+                            chargeType: plugin.prices && plugin.prices.length > 1 ? 3 : 1,
+                            tags: plugin.tags.map((t) => ({ tagValue: t })),
+                            languages: [
+                                {
+                                    language: 0,
+                                },
+                                {
+                                    language: 1,
+                                },
+                                {
+                                    language: 2,
+                                },
+                            ],
+                            translations: [
+                                {
+                                    name: plugin.languages.en.name,
+                                    overview: plugin.languages.en.overview,
+                                    description: plugin.languages.en.description,
+                                    language: 'en',
+                                },
+                                {
+                                    name: plugin.languages.es.name,
+                                    overview: plugin.languages.es.overview,
+                                    description: plugin.languages.es.description,
+                                    language: 'es',
+                                },
+                            ],
+                            billings: plugin.prices?.map((p) => ({
+                                name: p.name,
+                                description: p.description,
+                                price: p.price,
+                                // TODO: I don't know exactly what it means yet
+                                language: 'pt',
+                                // TODO: This one too
+                                currency: 1,
+                                chargeType: 1,
+                                isRecommended: p.isRecommended,
+                                featuresIncluded: JSON.stringify(p.featuresIncluded),
+                                additionalDescription: p.additionalDescription,
+                                isActive: true,
+                            })),
+                        },
+                    ],
+                },
+            },
+            opts,
+        )
+    }
+
     /** This route can only be called by an admin user of blip.ai */
     public updatePlugin(
         pluginId: string,
         plugin: Partial<
-            Pick<DetailedPlugin, 'name' | 'overview' | 'description' | 'icon' | 'documentation'> & { url: string }
+            Pick<DetailedPlugin, 'name' | 'overview' | 'description' | 'icon' | 'documentation' | 'price'> & {
+                url: string
+            }
         >,
         opts?: ConsumeOptions,
     ): Promise<void> {
@@ -241,34 +386,44 @@ export class PluginsNamespace extends Namespace {
                     icon: plugin.icon,
                     website: plugin.documentation,
                     url: plugin.url,
+                    price: plugin.price,
+                    isPaid: plugin.price !== undefined && plugin.price > 0,
                 },
             },
             opts,
         )
     }
 
-    /** This route can only be called by an admin user of blip.ai */
-    public deletePluginMedia(imageId: string, opts?: ConsumeOptions) {
-        return this.sendCommand(
-            {
-                method: 'delete',
-                uri: uri`/images/${imageId}`,
-            },
-            opts,
-        )
-    }
-
-    /** This route can only be called by an admin user of blip.ai */
-    public addPluginMedia(pluginId: string, type: 'image' | 'video', url: string, opts?: ConsumeOptions) {
+    public setPluginBilling(
+        pluginId: string,
+        billingId: string,
+        billing: Omit<PluginBilling, 'billingId' | 'currency' | 'language' | 'featuresIncluded'> & {
+            featuresIncluded: Array<{
+                icon: string
+                description: string
+            }>
+        },
+        opts?: ConsumeOptions,
+    ) {
         return this.sendCommand(
             {
                 method: 'set',
-                type: 'application/vnd.iris.plugins.image-create+json',
-                uri: uri`/images`,
+                type: 'application/vnd.iris.plugins.billing-update+json',
+                uri: uri`/billings/${billingId}`,
                 resource: {
-                    uri: url,
-                    pluginId,
-                    imageType: type === 'image' ? 3 : 1,
+                    blipPluginId: pluginId,
+                    name: billing.name,
+                    description: billing.description,
+                    featuresIncluded: billing.featuresIncluded ? JSON.stringify(billing.featuresIncluded) : undefined,
+                    isRecommended: billing.isRecommended,
+                    price: billing.price,
+                    additionalDescription: billing.additionalDescription,
+                    // TODO: add params to this
+                    language: 'pt',
+                    // TODO: This one too
+                    currency: 1,
+                    chargeType: 3,
+                    isActive: true,
                 },
             },
             opts,

package/src/types/message.ts

@@ -1,3 +1,4 @@
+import type { ThreadItem } from './account.ts'
 import type { JsonObject } from './commons.ts'
 import type { TicketStatus } from './desk.ts'
 import type { Envelope } from './envelope.ts'
@@ -115,3 +116,26 @@ export const messageToDocument = <Type extends MessageTypes>(
     type: message.type,
     value: message.content,
 })
+
+/** @description Best effort to figure out the date the message was created */
+export const messageDate = (message: UnknownMessage): Date | undefined => {
+    return message.metadata?.['#envelope.storageDate']
+        ? new Date(message.metadata['#envelope.storageDate'])
+        : message.metadata?.date_created
+          ? new Date(Number(message.metadata.date_created))
+          : message.metadata?.['#date_processed']
+            ? new Date(Number(message.metadata['#date_processed']))
+            : undefined
+}
+
+/** @returns Best effort to figure out the actual unique ID, since `message.id` can have collisions */
+export const messageUniqueId = (message: UnknownMessage | ThreadItem) => {
+    // Blip doesn't have a standard unique identifier, we need to try multiple sources that may not be present
+    return (
+        message.metadata?.['#uniqueId'] ??
+        message.metadata?.$internalId ??
+        message.metadata?.['#messageId'] ??
+        message.metadata?.['#envelope.storageDate'] ??
+        message.id
+    )
+}

package/src/types/plugins.ts

@@ -33,10 +33,11 @@ export type PluginBilling = {
     currency: string
     description: string
     featuresIncluded: string
-    isRecommended: boolean
+    isRecommended?: boolean
     language: string
     name: string
     price: number
+    additionalDescription?: string
 }
 
 export type PluginSubscription = DetailedPlugin & {