ninchat-embed 2.4.1 → 2.5.0

package/README.md

@@ -1224,20 +1224,47 @@ Change a route on Ninchat in iframe.
 Ninchat.route(Route)
 ```
 
-## Enums
+## Events
 
-#### [Ninchat.Event](#events)
+#### Common Events for both embed 'app' and 'queue' versions
+
+| Event | Event name | Parameters | Description |
+| ----------- | ---------- | ---------- | ----------- |
+| Route | route | `route`: {`name`, `params`, `audience_id?`, `metadata?`} | Emitted whenever user's route in Ninchat is changed |
+| Error | error | `error_type`: string, plus error-specific fields | Emitted when an error occurs |
+| ActivityCount | activity_count | `activity`: number, `highlights`: number | Typical use case for `ActivityCount` is to display activity as a number in host sites favicon. `activity` property contains the total activity including `highlights`. `highlights` are activity which has importance based on users settings or their role. Eg. highlight can be a name mention or a visitor requesting an audience. |
+| AudienceEnded | audience_eneded | `audience_id`: string | Emitted when an audience session ends |
+| AudienceClosed | audience_closed | `audience_id`: string | Emitted when the chat is closed |
+| SessionCreated | session_created | `user_queues?`: {[queue_id]: {`delivery_time`, `queue_time`, `realm_id`, `queue_attrs`}}, `user_channels?`: {[channel_id]: {`channel_attrs`, `channel_status?`, `realm_id?`}} | Emitted when a user session is created with queue and channel information |
+| QueueUpdated | queue_updated | `queue_id`: string, `queue_attrs`: {`name`, `length`, `group_id`, `is_group`}, `queue_time?`: number, `realm_id?`: string | Emitted when queue information is updated |
+| ChannelUpdated | channel_updated | `channel_id`: string, `channel_attrs`: {`audience_id`, `queue_id`, `name`, `closed`}, `channel_status?`: string, `realm_id?`: string | Emitted when channel information is updated |
+| ContainerInitialized | container_initialized | - | Emitted when the embed container is initialized |
+
+#### Events for 'app' version
+
+| Event | Event name | Parameters | Description |
+| ----------- | ---------- | ---------- | ----------- |
+| AudienceAccepted | audience_accepted | `audience_id`: string, `metadata?`: Record<string, unknown>[] | Emitted when a new chat session is started | 
+| AcceptAudienceError | accept_audience_error | `queue_id`: string, `audience_id?`: string, `reason?`: string | event to parent frame if related event dispatch has been rejected |
+| AcceptServiceRequestError | accept_service_request_error | `queue_id`: string, `reason?`: string | event to parent frame if related event assign transcript dispatch has been rejected |
+| Notification | notification | `type`: NotificationType, `audio?`: boolean, `channel_name?`: string, `desktop?`: boolean, `message?`: string, `queue_name?`: string, `realm_name?`: string, `user_name?`: string | `Notification` event is emited whenever user would receive either a desktop or an audio notification based on users preferences. When Ninchat is embedded, instead of firing a desktop or audio notification, a `Notification` event is emited instead. |
+
+
+#### Events for 'queue' version
+
+| Event | Event name | Parameters | Description |
+| ----------- | ---------- | ---------- | ----------- |
+| AudienceEnqueued | audience_enqueued | `audience_id`: string, `position`: number, `queue_id`: string | Emitted when user is placed in a queue with their position |
+| AudienceEnqueuedNext | audience_enqueued_next | `audience_id`: string, `queue_id`: string | Emitted when user is next in the queue |
+| AudienceStarted | audience_started | `audience_id`: string, `channel_id`: string | Emitted when an audience/chat session starts |
+| AudienceResumed | audience_resumed | `channel_id`: string | Emitted when an audience/chat session is resumed, for example after browser refresh |
+| AudienceRegistered | audience_registered | `queue_id`: string | Emitted when user registers to a queue |
+| AudienceTransferred | audience_transferred | `audience_id`: string, `audience_transferred`: string, `channel_id`: string | Emitted when an audience is transferred to another queue |
+| MessageReceived | message_received | `channel_id`: string | Emitted when a message is received in a channel |
+| MessageSent | message_sent | `channel_id`: string | Emitted when a message is sent in a channel |
+| State | state | `state`: 'minimized' \| 'open' \| 'full' | Emitted when embed display state changes |
+| Close | close | - | Emitted when the embed is closed |
 
-| Enum value                                                  |
-| ----------------------------------------------------------- |
-| [`ActivityCount`](#ninchateventactivitycount)               |
-| [`AudienceAccepted`](#ninchateventaudienceaccepted)         |
-| [`AudienceClosed`](#ninchateventaudienceclosed)             |
-| [`AudienceEnded`](#ninchateventaudienceended)               |
-| [`ContainerInitialized`](#ninchateventcontainerinitialized) |
-| [`Error`](#ninchateventerror)                               |
-| [`Notification`](#ninchateventnotification)                 |
-| [`Route`](#ninchateventroute)                               |
 
 #### Ninchat.ErrorType
 
@@ -1274,125 +1301,18 @@ the `route.name` property is one of the following:
 | Enum value          |
 | ------------------- |
 | `Channel`           |
-| `Else`              |
+| `Queue`             |
 | `Transcript`        |
+| `Realm`             |
+| `Else`              |
+| ------------------- |
+| `EmbedChannel` -> embed queue only |
+| `EmbedQueue` -> embed queue only |
 
-## Events
-
-Currently, the following events are supported:
-
-#### Ninchat.Event.ActivityCount
-
-```typescript
-{
-    event: Ninchat.Event.ActivityCount
-    activity: number
-    highlights: number
-}
-```
-
-Typical use case for `ActivityCount` is to display activity as a number in host sites favicon.
-`activity` property contains the total activity including `highlights`.
-
-`highlights` are activity which has importance based on users settings or their role.
-Eg. highlight can be a name mention or a visitor requesting an audience.
-
-#### Ninchat.Event.AudienceAccepted
-
-```typescript
-{
-    audience_id: string
-    event: Ninchat.Event.AudienceAccepted
-    metadata?: []
-}
-```
-
-`AudienceAccepted` event is emitted when a new chat session is started by interaction in current user interface.
-
-`metadata` array follows specifications described at [`AudienceRoute`](#audienceroute),
-
-#### Ninchat.Event.AudienceClosed
-
-```typescript
-{
-    audience_id: string
-    event: Ninchat.Event.AudienceClosed
-}
-```
-
-`AudienceClosed` event is emitted when the chat is closed.
-
-#### Ninchat.Event.AudienceEnded
-
-```typescript
-{
-    audience_id: string
-    event: Ninchat.Event.AudienceEnded
-}
-```
-
-`AudienceEnded` event is emitted when the chat session is ended.
-
-#### Ninchat.Event.ContainerInitialized
-
-```typescript
-{
-    event: Ninchat.Event.ContainerInitialized
-}
-```
-
-#### Ninchat.Event.Error
-
-```typescript
-{
-    error_type: string
-    event: Ninchat.Event.Error
-}
-```
-
-#### Ninchat.Event.Notification
-
-```typescript
-{
-    audio?: boolean
-    channel_name?: string
-    desktop?: boolean
-    event: Ninchat.Event.Notification
-    queue_name?: string
-    realm_name?: string
-    type: Ninchat.NotificationType
-    user_name?: string
-}
-```
-
-`Notification` event is emited whenever user would receive either a desktop or an audio notification
-based on users preferences. When Ninchat is embedded, instead of firing a desktop or audio notification,
-a `Notification` event is emited instead.
-
-#### Ninchat.Event.Route
-
-```typescript
-{
-    event: Ninchat.Event.Route
-    route: AudienceRoute | ChannelRoute | ElseRoute | TranscriptRoute
-}
-```
-
-`Route` event is emited whenever users route in Ninchat is changed. Host site can distinquish between different routes based on
-the passed properties. `metadata` in `AudienceRoute` and `TranscriptRoute` contains pre-whitelisted subset of audience customers metadata.
 
-##### AudienceRoute
+## Examples
 
-```typescript
-{
-    audience_id: string
-    name: Ninchat.RouteName.Channel
-    metadata?: []
-    params: {
-        channel_id: string
-    }
-}
-```
+### Metadata 
 
 `metadata` array contains secure metadata which is exposed to the parent on purpose. Array is used here, since in conversation can be multiple users with metadata.
 
@@ -1430,42 +1350,6 @@ Example: secure metadata containing following `shared` field..
 }
 ```
 
-##### ChannelRoute
-
-```typescript
-{
-    name: Ninchat.RouteName.Channel
-    params: {
-        channel_id: string
-    }
-}
-```
-
-##### ElseRoute
-
-```typescript
-{
-    name: Ninchat.RouteName.Else
-}
-```
-
-##### TranscriptRoute
-
-```typescript
-{
-    audience_id: string
-    name: Ninchat.RouteName.Transcript
-    metadata?: []
-    params: {
-        audience_id: string
-    }
-}
-```
-
-`metadata` array follows specifications described at [`AudienceRoute`](#audienceroute),
-
-## Examples
-
 ### SSO
 
 SSO using email address:
@@ -1547,6 +1431,10 @@ Ninchat.route(route)
 
 ## Release history
 
+### v2.5.0
+
+- add AcceptAudienceError and AcceptServiceRequestError events
+
 ### v2.4.1
 
 - force library code into single file