@lilaquadrat/chat 0.1.6 → 0.1.8

package/dist/studio-chat-module.js

@@ -1 +0,0 @@
-

package/dist/studio-chat-module.umd.cjs

@@ -1 +1 @@
-!function(n){"function"==typeof define&&define.amd?define(n):n()}(function(){});
+!function(n){"function"==typeof define&&define.amd&&define([],n)}(function(){});

package/dist/types/src/composables/useChatVisibility.d.ts

@@ -1,12 +1,18 @@
 import { type Ref } from 'vue';
 /**
  * tracks whether the chat is actually visible to the user:
- * - the element must intersect the viewport (catches display:none / collapsed hosts)
+ * - the element must intersect the viewport (catches display:none, collapsed hosts, and a
+ *   host that parks the widget off screen — the supported way to hide an embedded instance)
  * - the tab must be in the foreground
  * - in compact mode no left panel may overlay the chat (occlusion is not detectable
  *   cross-browser, so our own overlay state is checked explicitly)
+ *
+ * Purely visual hiding — `opacity: 0` — is deliberately NOT detected: no observer reports it
+ * and probing for it means walking every ancestor's computed style on each check. Hosts hide
+ * the widget by moving it out of the viewport (or `display: none`) instead.
  */
 export declare function useChatVisibility(element: Ref<HTMLElement | undefined>): {
     chatVisible: import("vue").ComputedRef<boolean>;
+    isVisibleNow: () => boolean;
 };
 export default useChatVisibility;

package/dist/types/src/config/bootstrap.d.ts

@@ -44,6 +44,14 @@ export interface ChatModuleConfig {
     }) => void;
     /** called when the close button in the header is clicked */
     close?: () => void;
+    /**
+     * notification sounds. On at full volume by default; `false` silences them.
+     * A sound is only played for remote events the user cannot currently see.
+     */
+    sound?: boolean | {
+        enabled?: boolean;
+        volume?: number;
+    };
     /** the host's auth token (Auth0 JWT). Identity is derived from its `sub`; sent as Bearer + WS auth. */
     token?: string;
     /**

package/dist/types/src/helpers/participants.d.ts

@@ -21,5 +21,5 @@ export type Participant = string | ParticipantUser;
 export declare function participantId(participant: Participant): string;
 /** map a participant list to its ids (e.g. before sending to the backend) */
 export declare function participantIds(participants?: Participant[]): string[];
-/** human-readable name: prename+lastname, else host name, else the raw id */
+/** human-readable name: "lastname, prename", else host name, else the raw id */
 export declare function participantName(participant: Participant): string;

package/dist/types/src/helpers/rights.d.ts

@@ -0,0 +1,19 @@
+export interface ConversationRightsSource {
+    isNew?: boolean;
+    participant?: {
+        state?: string;
+        rights?: string[];
+    };
+}
+type Conversation = ConversationRightsSource | null | undefined;
+/**
+ * still a member? drafts count, every non-active backend state does not — the server
+ * knows 'active' | 'left' | 'removed' | 'blocked' | 'deleted' and keeps only 'active'
+ * participants in `conversation.participants` (see participants.service).
+ * A missing state means the payload does not track it — treated as a member, the
+ * rights check below still applies.
+ */
+export declare function isActiveParticipant(conversation: Conversation): boolean;
+/** membership plus the named right ('read' | 'write' | 'rename' | 'participants' | 'block') */
+export declare function can(conversation: Conversation, right: string): boolean;
+export default can;

package/dist/types/src/helpers/sounds.d.ts

@@ -0,0 +1,8 @@
+export type SoundName = 'new-message' | 'new-conversation';
+/**
+ * Play a notification sound. Never throws and never rejects: browsers refuse audio until
+ * the page has seen a user gesture, and a machine without an output device rejects too —
+ * neither is worth surfacing for something purely decorative.
+ */
+export declare function playSound(name: SoundName, volume?: number): void;
+export default playSound;

package/dist/types/src/libs/StudioSDK.d.ts

@@ -78,6 +78,11 @@ export default class StudioSDK {
     static handleCall<T, D = any>(call: AxiosRequestConfig<D>, options?: SDKCallOptions): Promise<SDKResponse<T>>;
     static cache<T>(url: string, response?: AxiosResponse<T>, options?: SDKCallOptions): SDKResponse<any> & SDKCache;
     static flushCache(group?: string, action?: string): void;
+    /**
+    * one id can hold several entries (one per query string, e.g. every `beforeId` page of a
+    * conversation), so flushing has to drop all of them — otherwise a new message would only
+    * invalidate the page whose url happened to match.
+    */
     static flushId(id: string): void;
     conversations: {
         list: () => Promise<SDKResponse<any>>;
@@ -88,6 +93,11 @@ export default class StudioSDK {
         rename: (conversationId: string, name: string) => Promise<SDKResponse<any>>;
         participants: (conversationId: string, add: string[], remove: string[]) => Promise<SDKResponse<any>>;
         leave: (conversationId: string) => Promise<SDKResponse<any>>;
+        /**
+        * POST, not DELETE: this removes the conversation for the CALLER only (their participant
+        * state goes to 'deleted' server-side), it does not delete the resource for everyone.
+        */
+        delete: (conversationId: string) => Promise<SDKResponse<any>>;
         listParticipants: (conversationId: string) => Promise<SDKResponse<any>>;
         rights: (conversationId: string, user: string, rights: string[]) => Promise<SDKResponse<any>>;
         block: (conversationId: string, user: string, block: boolean) => Promise<SDKResponse<any>>;

package/dist/types/src/locales/de.d.ts

@@ -3,40 +3,72 @@ declare const _default: {
         connected: string;
         disconnected: string;
     };
-    actions: {
-        retry: string;
-    };
+    retry: string;
     'new chat': string;
     conversations: string;
     'contact support': string;
     support: string;
     options: string;
+    actions: string;
     mute: string;
     delete: string;
     leave: string;
     'leave now': string;
+    'delete now': string;
     'select contacts': string;
     'conversation options': string;
     'save edits': string;
     'cancel edits': string;
-    'participant rights': string;
+    abandon: string;
+    close: string;
+    rights: string;
+    members: string;
+    'update members': string;
     read: string;
     write: string;
     rename: string;
+    save: string;
+    'conversation name': string;
+    'you left this conversation': string;
     participants: string;
-    members: string;
+    'filter members': string;
+    'filter contacts': string;
+    'member count': string;
+    'created at': string;
+    'last activity': string;
+    messages: string;
     accept: string;
     decline: string;
+    'confirm action': string;
     block: string;
     unblock: string;
+    dismiss: string;
+    errors: {
+        unknown: string;
+        RATE_LIMIT_EXCEEDED: string;
+        NOT_ALLOWED: string;
+        ACTION_NOT_ALLOWED: string;
+        NOT_A_CONTACT: string;
+        CONVERSATION_NOT_FOUND: string;
+        CONVERSATION_ALREADY_EXISTS: string;
+        MIN_PARTICIPANTS: string;
+        CONTACT_NOT_FOUND: string;
+        CANNOT_BLOCK_SELF: string;
+        UNKNOWN_MESSAGE_TYPE: string;
+        INVALID_LAST_READ_ID: string;
+        INTERNAL_ERROR: string;
+    };
     system: {
         renamed: string;
         created: string;
         left: string;
+        blocked: string;
+        unblocked: string;
         participants: {
             addedAndRemoved: string;
             added: string;
             removed: string;
+            updated: string;
         };
     };
 };

package/dist/types/src/locales/en.d.ts

@@ -3,40 +3,72 @@ declare const _default: {
         connected: string;
         disconnected: string;
     };
-    actions: {
-        retry: string;
-    };
+    retry: string;
     'new chat': string;
     conversations: string;
     'contact support': string;
     support: string;
     options: string;
+    actions: string;
     mute: string;
     delete: string;
     leave: string;
     'leave now': string;
+    'delete now': string;
     'select contacts': string;
     'conversation options': string;
     'save edits': string;
     'cancel edits': string;
-    'participant rights': string;
+    abandon: string;
+    close: string;
+    rights: string;
+    members: string;
+    'update members': string;
     read: string;
     write: string;
     rename: string;
+    save: string;
+    'conversation name': string;
+    'you left this conversation': string;
     participants: string;
-    members: string;
+    'filter members': string;
+    'filter contacts': string;
+    'member count': string;
+    'created at': string;
+    'last activity': string;
+    messages: string;
     accept: string;
     decline: string;
+    'confirm action': string;
     block: string;
     unblock: string;
+    dismiss: string;
+    errors: {
+        unknown: string;
+        RATE_LIMIT_EXCEEDED: string;
+        NOT_ALLOWED: string;
+        ACTION_NOT_ALLOWED: string;
+        NOT_A_CONTACT: string;
+        CONVERSATION_NOT_FOUND: string;
+        CONVERSATION_ALREADY_EXISTS: string;
+        MIN_PARTICIPANTS: string;
+        CONTACT_NOT_FOUND: string;
+        CANNOT_BLOCK_SELF: string;
+        UNKNOWN_MESSAGE_TYPE: string;
+        INVALID_LAST_READ_ID: string;
+        INTERNAL_ERROR: string;
+    };
     system: {
         renamed: string;
         created: string;
         left: string;
+        blocked: string;
+        unblocked: string;
         participants: {
             addedAndRemoved: string;
             added: string;
             removed: string;
+            updated: string;
         };
     };
 };

package/dist/types/src/plugins/i18n.d.ts

@@ -7,40 +7,72 @@ declare const i18n: import("vue-i18n").I18n<{
             connected: string;
             disconnected: string;
         };
-        actions: {
-            retry: string;
-        };
+        retry: string;
         'new chat': string;
         conversations: string;
         'contact support': string;
         support: string;
         options: string;
+        actions: string;
         mute: string;
         delete: string;
         leave: string;
         'leave now': string;
+        'delete now': string;
         'select contacts': string;
         'conversation options': string;
         'save edits': string;
         'cancel edits': string;
-        'participant rights': string;
+        abandon: string;
+        close: string;
+        rights: string;
+        members: string;
+        'update members': string;
         read: string;
         write: string;
         rename: string;
+        save: string;
+        'conversation name': string;
+        'you left this conversation': string;
         participants: string;
-        members: string;
+        'filter members': string;
+        'filter contacts': string;
+        'member count': string;
+        'created at': string;
+        'last activity': string;
+        messages: string;
         accept: string;
         decline: string;
+        'confirm action': string;
         block: string;
         unblock: string;
+        dismiss: string;
+        errors: {
+            unknown: string;
+            RATE_LIMIT_EXCEEDED: string;
+            NOT_ALLOWED: string;
+            ACTION_NOT_ALLOWED: string;
+            NOT_A_CONTACT: string;
+            CONVERSATION_NOT_FOUND: string;
+            CONVERSATION_ALREADY_EXISTS: string;
+            MIN_PARTICIPANTS: string;
+            CONTACT_NOT_FOUND: string;
+            CANNOT_BLOCK_SELF: string;
+            UNKNOWN_MESSAGE_TYPE: string;
+            INVALID_LAST_READ_ID: string;
+            INTERNAL_ERROR: string;
+        };
         system: {
             renamed: string;
             created: string;
             left: string;
+            blocked: string;
+            unblocked: string;
             participants: {
                 addedAndRemoved: string;
                 added: string;
                 removed: string;
+                updated: string;
             };
         };
     };

package/dist/types/src/standalone/settings.d.ts

@@ -26,6 +26,10 @@ export interface StandaloneSettings {
         support?: {
             participants: string[];
         };
+        sound?: boolean | {
+            enabled?: boolean;
+            volume?: number;
+        };
     };
     /** document title of the deployment */
     title?: string;

package/dist/types/src/stores/conversations.store.d.ts

@@ -48,7 +48,11 @@ export declare const useConversationsStore: import("pinia").StoreDefinition<"con
     executeParticipantsEdit: (conversation: string, add: string[], remove: string[]) => Promise<import("@/libs/StudioSDK").SDKResponse<any>>;
     updateConversationParticipant: (conversation: string, state: string) => void;
     leave: (conversation: string) => Promise<import("@/libs/StudioSDK").SDKResponse<any>>;
-}, "conversations" | "typing" | "activeConversation">, Pick<{
+    deleteConversation: (conversation: string) => Promise<void>;
+    lastActiveConversation: import("vue").Ref<any, any>;
+    activateLastConversation: () => void;
+    readLastActiveConversation: () => void;
+}, "conversations" | "typing" | "activeConversation" | "lastActiveConversation">, Pick<{
     getAllConversations: () => Promise<void>;
     refreshConversations: () => Promise<void>;
     handleReconnect: () => Promise<void>;
@@ -94,6 +98,10 @@ export declare const useConversationsStore: import("pinia").StoreDefinition<"con
     executeParticipantsEdit: (conversation: string, add: string[], remove: string[]) => Promise<import("@/libs/StudioSDK").SDKResponse<any>>;
     updateConversationParticipant: (conversation: string, state: string) => void;
     leave: (conversation: string) => Promise<import("@/libs/StudioSDK").SDKResponse<any>>;
+    deleteConversation: (conversation: string) => Promise<void>;
+    lastActiveConversation: import("vue").Ref<any, any>;
+    activateLastConversation: () => void;
+    readLastActiveConversation: () => void;
 }, "unreadConversations" | "totalUnreadCount" | "totalUnreadConversations">, Pick<{
     getAllConversations: () => Promise<void>;
     refreshConversations: () => Promise<void>;
@@ -140,5 +148,9 @@ export declare const useConversationsStore: import("pinia").StoreDefinition<"con
     executeParticipantsEdit: (conversation: string, add: string[], remove: string[]) => Promise<import("@/libs/StudioSDK").SDKResponse<any>>;
     updateConversationParticipant: (conversation: string, state: string) => void;
     leave: (conversation: string) => Promise<import("@/libs/StudioSDK").SDKResponse<any>>;
-}, "leave" | "rename" | "getAllConversations" | "refreshConversations" | "handleReconnect" | "setTyping" | "loadParticipants" | "setRights" | "blockUser" | "updateParticipantRights" | "create" | "createNew" | "startSupport" | "activateConversation" | "convertTempToConversation" | "getMessagesFromApi" | "addMessagesToConversation" | "getMessagesForConversation" | "updateLastMessage" | "updateUnread" | "updateAllUnread" | "increaseMessageCount" | "increaseMessageCountSystem" | "setLastReadId" | "getConversation" | "addParticipant" | "removeParticipant" | "setParticipants" | "toggleParticipant" | "getConversationViaParticipantsAndName" | "cleanConversations" | "abandonConversation" | "inactivateConversation" | "conversationRenamed" | "executeParticipantsEdit" | "updateConversationParticipant">>;
+    deleteConversation: (conversation: string) => Promise<void>;
+    lastActiveConversation: import("vue").Ref<any, any>;
+    activateLastConversation: () => void;
+    readLastActiveConversation: () => void;
+}, "leave" | "rename" | "getAllConversations" | "refreshConversations" | "handleReconnect" | "setTyping" | "loadParticipants" | "setRights" | "blockUser" | "updateParticipantRights" | "create" | "createNew" | "startSupport" | "activateConversation" | "convertTempToConversation" | "getMessagesFromApi" | "addMessagesToConversation" | "getMessagesForConversation" | "updateLastMessage" | "updateUnread" | "updateAllUnread" | "increaseMessageCount" | "increaseMessageCountSystem" | "setLastReadId" | "getConversation" | "addParticipant" | "removeParticipant" | "setParticipants" | "toggleParticipant" | "getConversationViaParticipantsAndName" | "cleanConversations" | "abandonConversation" | "inactivateConversation" | "conversationRenamed" | "executeParticipantsEdit" | "updateConversationParticipant" | "deleteConversation" | "activateLastConversation" | "readLastActiveConversation">>;
 export default useConversationsStore;

package/dist/types/src/stores/main.store.d.ts

@@ -1,17 +1,18 @@
 export type Feature = 'chat' | 'support';
-export type LeftTarget = 'conversations' | 'contacts-new' | 'contacts-edit';
+export type LeftTarget = 'conversations' | 'contacts-new' | 'contacts-edit' | 'contacts-rights' | 'rename';
 export type MainTarget = 'chat';
 export declare const useMainStore: import("pinia").StoreDefinition<"main", Pick<{
-    leftTarget: import("vue").Ref<LeftTarget, LeftTarget>;
-    mainTarget: import("vue").Ref<"chat", "chat">;
     state: import("vue").Ref<"connected" | "disconnected", "connected" | "disconnected">;
     fullscreen: import("vue").Ref<boolean, boolean>;
     features: import("vue").Ref<Feature[], Feature[]>;
     hasChat: import("vue").ComputedRef<boolean>;
     hasSupport: import("vue").ComputedRef<boolean>;
     isSupportOnly: import("vue").ComputedRef<boolean>;
-    viewMode: import("vue").Ref<"full" | "compact", "full" | "compact">;
-    setViewMode: (newViewMode: "compact" | "full") => void;
+    viewMode: import("vue").Ref<"mobile" | "tablet" | "desktop", "mobile" | "tablet" | "desktop">;
+    setViewMode: (newViewMode: "mobile" | "tablet" | "desktop") => void;
+    chatVisible: import("vue").Ref<boolean, boolean>;
+    soundEnabled: import("vue").Ref<boolean, boolean>;
+    soundVolume: import("vue").Ref<number, number>;
     supportParticipants: import("vue").Ref<string[], string[]>;
     wsUrl: import("vue").Ref<string, string>;
     apiUrl: import("vue").Ref<string, string>;
@@ -25,21 +26,42 @@ export declare const useMainStore: import("pinia").StoreDefinition<"main", Pick<
         unreadConversations: number;
     }) => void>;
     closeCallback: import("vue").Ref<() => void, () => void>;
-    showConversations: () => void;
-    showNewChat: () => void;
-    showEditChat: () => void;
-    hideLeft: () => void;
-}, "state" | "leftTarget" | "mainTarget" | "fullscreen" | "features" | "viewMode" | "supportParticipants" | "wsUrl" | "apiUrl" | "mediaUrl" | "authToken" | "unreadCallback" | "closeCallback">, Pick<{
-    leftTarget: import("vue").Ref<LeftTarget, LeftTarget>;
-    mainTarget: import("vue").Ref<"chat", "chat">;
+    setContent: (type: string, target: "left" | "main" | "right") => void;
+    unsetContent: (target: "left" | "main" | "right") => void;
+    content: import("vue").Ref<{
+        left: string | undefined;
+        main: string | undefined;
+        right: string | undefined;
+    }, {
+        left: string | undefined;
+        main: string | undefined;
+        right: string | undefined;
+    } | {
+        left: string | undefined;
+        main: string | undefined;
+        right: string | undefined;
+    }>;
+    lastError: import("vue").Ref<{
+        error: string;
+        messageType?: string;
+    }, {
+        error: string;
+        messageType?: string;
+    }>;
+    setError: (error: string, messageType?: string) => void;
+    clearError: () => void;
+}, "state" | "fullscreen" | "features" | "viewMode" | "chatVisible" | "soundEnabled" | "soundVolume" | "supportParticipants" | "wsUrl" | "apiUrl" | "mediaUrl" | "authToken" | "unreadCallback" | "closeCallback" | "content" | "lastError">, Pick<{
     state: import("vue").Ref<"connected" | "disconnected", "connected" | "disconnected">;
     fullscreen: import("vue").Ref<boolean, boolean>;
     features: import("vue").Ref<Feature[], Feature[]>;
     hasChat: import("vue").ComputedRef<boolean>;
     hasSupport: import("vue").ComputedRef<boolean>;
     isSupportOnly: import("vue").ComputedRef<boolean>;
-    viewMode: import("vue").Ref<"full" | "compact", "full" | "compact">;
-    setViewMode: (newViewMode: "compact" | "full") => void;
+    viewMode: import("vue").Ref<"mobile" | "tablet" | "desktop", "mobile" | "tablet" | "desktop">;
+    setViewMode: (newViewMode: "mobile" | "tablet" | "desktop") => void;
+    chatVisible: import("vue").Ref<boolean, boolean>;
+    soundEnabled: import("vue").Ref<boolean, boolean>;
+    soundVolume: import("vue").Ref<number, number>;
     supportParticipants: import("vue").Ref<string[], string[]>;
     wsUrl: import("vue").Ref<string, string>;
     apiUrl: import("vue").Ref<string, string>;
@@ -53,21 +75,42 @@ export declare const useMainStore: import("pinia").StoreDefinition<"main", Pick<
         unreadConversations: number;
     }) => void>;
     closeCallback: import("vue").Ref<() => void, () => void>;
-    showConversations: () => void;
-    showNewChat: () => void;
-    showEditChat: () => void;
-    hideLeft: () => void;
+    setContent: (type: string, target: "left" | "main" | "right") => void;
+    unsetContent: (target: "left" | "main" | "right") => void;
+    content: import("vue").Ref<{
+        left: string | undefined;
+        main: string | undefined;
+        right: string | undefined;
+    }, {
+        left: string | undefined;
+        main: string | undefined;
+        right: string | undefined;
+    } | {
+        left: string | undefined;
+        main: string | undefined;
+        right: string | undefined;
+    }>;
+    lastError: import("vue").Ref<{
+        error: string;
+        messageType?: string;
+    }, {
+        error: string;
+        messageType?: string;
+    }>;
+    setError: (error: string, messageType?: string) => void;
+    clearError: () => void;
 }, "hasChat" | "hasSupport" | "isSupportOnly">, Pick<{
-    leftTarget: import("vue").Ref<LeftTarget, LeftTarget>;
-    mainTarget: import("vue").Ref<"chat", "chat">;
     state: import("vue").Ref<"connected" | "disconnected", "connected" | "disconnected">;
     fullscreen: import("vue").Ref<boolean, boolean>;
     features: import("vue").Ref<Feature[], Feature[]>;
     hasChat: import("vue").ComputedRef<boolean>;
     hasSupport: import("vue").ComputedRef<boolean>;
     isSupportOnly: import("vue").ComputedRef<boolean>;
-    viewMode: import("vue").Ref<"full" | "compact", "full" | "compact">;
-    setViewMode: (newViewMode: "compact" | "full") => void;
+    viewMode: import("vue").Ref<"mobile" | "tablet" | "desktop", "mobile" | "tablet" | "desktop">;
+    setViewMode: (newViewMode: "mobile" | "tablet" | "desktop") => void;
+    chatVisible: import("vue").Ref<boolean, boolean>;
+    soundEnabled: import("vue").Ref<boolean, boolean>;
+    soundVolume: import("vue").Ref<number, number>;
     supportParticipants: import("vue").Ref<string[], string[]>;
     wsUrl: import("vue").Ref<string, string>;
     apiUrl: import("vue").Ref<string, string>;
@@ -81,9 +124,29 @@ export declare const useMainStore: import("pinia").StoreDefinition<"main", Pick<
         unreadConversations: number;
     }) => void>;
     closeCallback: import("vue").Ref<() => void, () => void>;
-    showConversations: () => void;
-    showNewChat: () => void;
-    showEditChat: () => void;
-    hideLeft: () => void;
-}, "setViewMode" | "showConversations" | "showNewChat" | "showEditChat" | "hideLeft">>;
+    setContent: (type: string, target: "left" | "main" | "right") => void;
+    unsetContent: (target: "left" | "main" | "right") => void;
+    content: import("vue").Ref<{
+        left: string | undefined;
+        main: string | undefined;
+        right: string | undefined;
+    }, {
+        left: string | undefined;
+        main: string | undefined;
+        right: string | undefined;
+    } | {
+        left: string | undefined;
+        main: string | undefined;
+        right: string | undefined;
+    }>;
+    lastError: import("vue").Ref<{
+        error: string;
+        messageType?: string;
+    }, {
+        error: string;
+        messageType?: string;
+    }>;
+    setError: (error: string, messageType?: string) => void;
+    clearError: () => void;
+}, "setViewMode" | "setContent" | "unsetContent" | "setError" | "clearError">>;
 export default useMainStore;